Overview
PractitionerRole Information addresses:
- PractitionerRole HL7® FHIR® resource with US Core Profile 6.1.0
PractitionerRole covers the recording of the location and types of services that Practitioners are able to provide for an organization. This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Care Team Member and Practitioner Information.
The role, specialty, Location telecom and HealthcareService properties can be repeated if required in other instances of the PractitionerRole. Some systems record a collection of service values for a single location, others record the single service and the list of locations it is available. Both are acceptable options for representing this data. Where availability, telecom, or other details are not the same across all healthcare services, or locations a separate PractitionerRole instance should be created.
Each Practitioner supports next elements:
- an associated organization
- an associated practitioner
- a role
- a specialty
- an associated location
- contact information
- a communication endpoint
Profile specific implementation guidance:
- At least one of the following elements must be present:
- PractitionerRole.practitioner
- PractitionerRole.organization
- PractitionerRole.healthcareService
- PractitionerRole.location
- The PractitionerRole.endpoint is where a Direct address may be represented.
- Clients can request servers return the Practitioner resource and Endpoint resources by using
_include.
PractitionerRole response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version. This resource refers to US Core PractitionerRole Profile 6.1.0.
Must support elements, mandatory and optional search parameters
Practitionermust support these elements:
practitionerorganizationcodespecialtylocationtelecomsystemvalue
endpoint
The following search parameters and search parameter combinations SHALL be supported (mandatory):
The syntax used to describe the interactions is described here.
SHALL support searching practitioner role by specialty using the specialty search parameter:
- including optional support for these
_includeparameters:PractitionerRole:endpoint,PractitionerRole:practitioner
GET [base url]/PractitionerRole?specialty={system|}[code]
SHALL support searching practitioner role by practitioner using the practitioner search parameter:
- including support for chained parameters:
practitioner.identifier,practitioner.name - including optional support for these
_includeparameters:PractitionerRole:endpoint,PractitionerRole:practitioner
GET [base url]/PractitionerRole?practitioner={Type/}[id]
SHALL support searching using chained parameter for practitioner name:
GET [base url]/PractitionerRole?practitioner.name=[string]
SHALL support searching using chained parameter for practitioner identifier:
GET [base url]/PractitionerRole?practitioner.identifier={system|}[code]
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
PractitionerRole By Specialty
Search for PractitionerRole by specialty.
METHOD GET
GET [base url]/PractitionerRole?specialty={system|}[code]PARAMS
[base url] - FHIR base url
{system|} - The system for the specialty. FHIR search token parameter. See Search specification for more information. Example: http://nucc.org/provider-taxonomy|
[code] - Specialty code in the system. Example: 208D0000X (General Practice)
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/PractitionerRole?specialty=http://nucc.org/provider-taxonomy|208D0000X' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'PractitionerRole By Practitioner
Search for PractitionerRole by practitioner reference.
METHOD GET
GET [base url]/PractitionerRole?practitioner={Type/}[id]PARAMS
[base url] - FHIR base url
{Type/} - Type for the Reference. Example: Practitioner/
[id] - Id for Practitioner resource
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/PractitionerRole?practitioner=Practitioner/example' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'PractitionerRole By Practitioner Name (Chained)
Search for PractitionerRole using chained search on practitioner name.
METHOD GET
GET [base url]/PractitionerRole?practitioner.name=[string]PARAMS [base url] - FHIR base url [string] - Practitioner's name (any portion)
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/PractitionerRole?practitioner.name=Smith' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'PractitionerRole By Practitioner Identifier (Chained)
Search for PractitionerRole using chained search on practitioner identifier.
METHOD GET
GET [base url]/PractitionerRole?practitioner.identifier={system|}[code]PARAMS
[base url] - FHIR base url
{system|} - Identifier system. FHIR search token parameter. See Search specification for more information. Example: http://hl7.org/fhir/sid/us-npi|
[code] - Identifier code (e.g., NPI number)
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/PractitionerRole?practitioner.identifier=http://hl7.org/fhir/sid/us-npi|1234567890' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'PractitionerRole with Include Parameters
Search for PractitionerRole with included resources using _include parameters.
METHOD GET
GET [base url]/PractitionerRole?specialty={system|}[code]&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpointPARAMS [base url] - FHIR base url {system|} - The system for the specialty [code] - Specialty code _include - Include related resources in the response bundle
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/PractitionerRole?specialty=http://nucc.org/provider-taxonomy|208D0000X&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'