FHIR PractitionerRole
Base Path: /fhir/4.0/PractitionerRole
Version: 1.0.0
The FHIR PractitionerRole API allows you to look up and retrieve PractitionerRole information. The endpoint provides the ability to:
- Retrieve all PractitionerRole resources that match a search criteria.
- Retrieve a specific PractitionerRole resource based on its FHIR ID.
- Retrieve the history of an PractitionerRole resource based on its FHIR ID.
The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.
This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Methods
Retrieve PractitionerRole Resources by Criteria
GET /fhir/4.0/PractitionerRole/
This method returns all PractitionerRoles by search criteria.
Parameters
Name
Type
Data Type
Description
Name:
specialty
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the specialty of the practitioner.
Sample Value: http://snomed.info/sct/Dermatology|17561000
Name:
role
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles to those with specific roles which the practitioner may perform. Valus are passed in as {codingSystem}|{code}.
Sample Value: http://snomed.info/sct|25961008|
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on their current status.
Note: Set the value to true to retrieve active PractitionerRoles or false to retrieve inactive PractitionerRoles.
Sample Value: true
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the practitionerroles by the period during which the practitioner is authorized to perform in these role(s).
The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: gt2013-01-01T01:00:00%2B13:00
Name:
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on the contact email.
Sample Value: help@smiledental.com
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the technical endpoint providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Defines the identifier of a practitioner.
Sample Value: http://hl7.org/fhir/R4/practitionerrole.html|m0013
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the location reference at which the role orccurs.
Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
For example: location.name=medical-center&location.address-city=Auckland.
Sample Value: location=Location/f0004
Name:
organization
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the organization reference at which the practitioner represents / acts on behalf of.
Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas.
For example: organization.name=medical-center&lorganization.address=3300 Washtenaw Avenue, Suite 227.
Sample Value: organization=Organization/hl7payer
Name:
phone
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on the contact phone number.
Sample Value: 34059342
Name:
practitioner
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the reference practitioner that is able to provide the defined services for the organization. Note: This parameter can be chained to further define filters on the reference practitioner. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: practitioner.name=Anne
Name:
service
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles to those with specific service references.
Note: This parameter can be chained to further define filters on the reference healthcareService. For each chained parameter, you can specify multiple values separated by commas.
For example: service.service-category=medical-center&service.location=Location/loc12
Sample Value: service=HealthcareService/d0014
Name:
telecom
optional
Type:
query
Data Type:
string
Description:
Filters the HealthcareServices based on a value in any kind of contact.
Sample Value: fax|+1-555-987-1234
Name:
-include-sources
optional
Type:
query
Data Type:
array
Description:
The -include-sources parameter defines which sources should be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles
Name:
-exclude-sources
optional
Type:
query
Data Type:
array
Description:
The -exclude-sources parameter defines which sources should NOT be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns a FHIR Bundle containing 0..* PractitionerRole resources.
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Get all PractitionerRoles by crietria
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/?specialty=http://snomed.info/sct/Dermatology%7C17561000" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve PractitionerRoles by criteria
POST /fhir/4.0/PractitionerRole/_search
This method returns all PractitionerRoles by search criteria. This is the secure alternative to the GET search.
Parameters
Name
Type
Data Type
Description
Name:
Content-Type
required
Type:
header
Data Type:
string
Description:
Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded.
Sample Value: application/x-www-form-urlencoded
Name:
specialty
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the specialty of the practitioner.
Sample Value: http://snomed.info/sct/Dermatology|17561000
Name:
role
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles to those with specific roles which the practitioner may perform. Values are passed in as {codingSystem}|{code}.
Sample Value: 25961008|http://snomed.info/sct
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on their current status.
Note: Set the value to true to retrieve active PractitionerRoles or false to retrieve inactive PractitionerRoles.
Sample Value: true
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles by the period during which the practitioner is authorized to perform in these role(s).
The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: gt2013-01-01T01:00:00%2B13:00
Name:
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on the contact email.
Sample Value: help@smiledental.com
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the reference endpoints providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Defines the identifier of a practitioner.
Sample Value: http://hl7.org/fhir/R4/practitionerrole.html|m0013
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the location reference at which the role occurs.
Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
For example: location.name=medical-center&location.address-city=Auckland
Sample Value: location=Location/f0004
Name:
organization
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the organization reference at which the practitioner represents / acts on behalf of.
Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas.
For example: organization.name=medical-center&organization.address=3300 Washtenaw Avenue, Suite 227.
Sample Value: organization=Organization/hl7payer
Name:
phone
optional
Type:
query
Data Type:
string
Description:
Filters the PractitionerRoles based on the contact phone number.
Sample Value: 34059342
Name:
practitioner
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles based on the reference practitioner that is able to provide the defined services for the organization. Note: This parameter can be chained to further define filters on the reference practitioner. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: practitioner.name=Anne
Name:
service
optional
Type:
query
Data Type:
array
Description:
Filters the PractitionerRoles to those with specific service references.
Note: This parameter can be chained to further define filters on the reference healthcareService. For each chained parameter, you can specify multiple values separated by commas.
For example: service.service-category=medical-center&service.location=Location/loc12
Sample Value: service=HealthcareService/d0014
Name:
telecom
optional
Type:
query
Data Type:
string
Description:
Filters the HealthcareServices based on a value in any kind of contact.
Sample Value: fax|+1-555-987-1234
Name:
-include-sources
optional
Type:
query
Data Type:
array
Description:
The -include-sources parameter defines which sources should be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles
Name:
-exclude-sources
optional
Type:
query
Data Type:
array
Description:
The -exclude-sources parameter defines which sources should NOT be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns a FHIR Bundle containing 0..* PractitionerRole resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Get all PractitionerRoles by specific crietria
curl -X POST "https://developer-solution/fhir/4.0/PractitionerRole/_search?specialty=http://snomed.info/sct/Dermatology%7C17561000" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a single PractitionerRole
GET /fhir/4.0/PractitionerRole/{id}
This method returns the PractitionerRole resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the PractitionerRole resource to retrieve.
Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns an PractitionerRole resource matching the requested resource ID.
400
This code is returned when the FHIR ID is empty or not valid.
404
No PractitionerRole resource found with the requested resource ID.
Sample Requests
Retrieve a PractitionerRole identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve History for an PractitionerRole Resource by its FHIR ID
GET /fhir/4.0/PractitionerRole/{id}/_history
This method returns all the versions for a specific PractitionerRole resource based on its FHIR ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the PractitionerRole resource to retrieve history for.
Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns history of an PractitionerRole with given id in the response body.
404
PractitionerRole resource id is specified, but no corresponding resource is found.
Sample Requests
Retrieve the history of a PractitionerRole identified a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='