swagger: '2.0' info: description: "Fast Healthcare Interoperability Resources (FHIR, pronounced \"Fire\") defines a set of \"Resources\" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation. \n" title: Untitled CodeSystem PractitionerRole API version: unspecified host: api.prod.devoted.com basePath: /fhir/ schemes: - https tags: - name: PractitionerRole description: The PractitionerRole FHIR resource type paths: /PractitionerRole/{id}: get: tags: - PractitionerRole summary: 'read-instance: Read PractitionerRole instance' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null put: tags: - PractitionerRole summary: 'update-instance: Update an existing PractitionerRole instance, or create using a client-assigned ID' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"PractitionerRole\"\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null delete: tags: - PractitionerRole summary: 'instance-delete: Perform a logical delete on a resource instance' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null patch: tags: - PractitionerRole summary: 'instance-patch: Patch a resource instance of type PractitionerRole by ID' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/_history/{version_id}: get: tags: - PractitionerRole summary: 'vread-instance: Read PractitionerRole instance with specific version' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: '1' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole: get: tags: - PractitionerRole summary: 'search-type: Search for PractitionerRole instances' description: This is a search type parameters: - name: date in: query description: The period during which the practitioner is authorized to perform in these role(s) style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: "The practitioner has this specialty at an organization
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: "Practitioner that is able to provide the defined services for the organization
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" style: simple - name: service in: query description: The list of healthcare services that this worker provides for this role's Organization/Location(s) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The identity of the organization the practitioner represents / acts on behalf of style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole summary: 'create-type: Create a new PractitionerRole instance' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"PractitionerRole\"\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/_history: get: tags: - PractitionerRole summary: 'type-history: Fetch the resource change history for all resources of type PractitionerRole' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/_history: get: tags: - PractitionerRole summary: 'instance-history: Fetch the resource change history for all resources of type PractitionerRole' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/_search: get: tags: - PractitionerRole summary: 'search-type: Search for PractitionerRole instances' description: This is a search type parameters: - name: date in: query description: The period during which the practitioner is authorized to perform in these role(s) style: simple - name: identifier in: query description: A practitioner's Identifier style: simple - name: specialty in: query description: "The practitioner has this specialty at an organization
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: role in: query description: The practitioner can perform this role at for the organization style: simple - name: practitioner in: query description: "Practitioner that is able to provide the defined services for the organization
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: active in: query description: Whether this practitioner role record is in active use style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the practitioner with this role style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: phone in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" style: simple - name: service in: query description: The list of healthcare services that this worker provides for this role's Organization/Location(s) style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: The identity of the organization the practitioner represents / acts on behalf of style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: telecom in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" style: simple - name: location in: query description: One of the locations at which this practitioner provides care style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: email in: query description: "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$validate: get: tags: - PractitionerRole parameters: - name: mode in: query required: false style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"PractitionerRole\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$validate: get: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' - name: mode in: query required: false style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"PractitionerRole\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta-delete: post: tags: - PractitionerRole description: Delete tags, profiles, and/or security labels from a resource parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta-add: post: tags: - PractitionerRole description: Add tags, profiles, and/or security labels to a resource parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$meta: get: tags: - PractitionerRole description: Request a list of tags, profiles, and security labels for a specfic resource instance responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole description: Request a list of tags, profiles, and security labels for a specfic resource instance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\"\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$meta: get: tags: - PractitionerRole description: Request a list of tags, profiles, and security labels for a specfic resource instance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - PractitionerRole description: Request a list of tags, profiles, and security labels for a specfic resource instance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\"\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/$expunge: post: tags: - PractitionerRole requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /PractitionerRole/{id}/$expunge: post: tags: - PractitionerRole parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null components: schemas: FHIR-JSON-RESOURCE: type: object description: A FHIR resource example: null FHIR-XML-RESOURCE: type: object description: A FHIR resource example: null