0. References
HL7 UK | Care Connect Profile: PractitionerRole |
HL7 FHIR Resource: Practitioner Role |
User Stories: User Stories |
1. Read
Return a single PractitionerRole for the specified id.
All requests MUST contain a valid ‘Authorization’ header and SHOULD contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/fhir+json or application/fhir+xml.
1.1. Response
A full set of response codes can be found here API Response Codes. FHIR Servers MUST support the following response codes:
| 200 | successful operation |
| 400 | invalid parameter |
| 401/4xx | unauthorized request |
| 403 | insufficient scope |
| 404 | resource not found |
| 410 | resource deleted |
2. Search
Fetches a bundle of all PractitionerRole resources for the specified search criteria.
All requests MUST contain a valid ‘Authorization’ header and SHOULD contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/fhir+xml or application/fhir+json.
2.1. Search Parameters
The search parameters that are mandated as a minimum in the API for the Practitioner Role resource are detailed below.
Query parameters conformance will be categorised as:
MUST - these search parameters MUST be implemented for the specified resource type.
SHOULD - these search parameters are expected to be implemented, if the data to support the query is present in the host system.
Additional search parameters MAY be added to reflect local requirements.
To be conformant, provider systems are required to implement all of the MUST parameters.
The parameters can be used independently to help refine the search results returned.
| Name | Type | Description | Conformance | Path |
|---|---|---|---|---|
organization |
reference |
The identity of the organisation the practitioner represents / acts on behalf of | MUST | PractitionerRole.organization (Organization) |
practitioner |
reference |
Practitioner that is able to provide the defined services for the organisation | MUST | PractitionerRole.practitioner (Practitioner) |
2.1.1. organization
See reference for details on this parameter.
GET [baseUrl]/PractitionerRole?organization=1
Return all PractitionerRole resources that have a organization with Organization Id of 1. 2.1.2. practitioner
See reference for details on this parameter.
GET [baseUrl]/PractitionerRole?practitioner=1
Return all PractitionerRole resources that have a practitioner with Practitioner Id of 1. 2.2. Search Response
If the search fails (cannot be executed, not that there is no matches), the return value is a status code 4xx or 5xx with an OperationOutcome.
If the search succeeds, the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order. The result list can be long, so servers MAY use paging. If they do, they MUST use this Paging method for breaking the list into pages if appropriate. The server MAY also return an OperationOutcome resource with additional information about the search.
A full set of response codes can be found here API Response Codes. FHIR Servers MUST support the following response codes:
| 200 | successful operation |
| 400 | invalid parameter |
| 401/4xx | unauthorized request |
| 403 | insufficient scope |
| 404 | resource not found |
| 410 | resource deleted |
3.1 cURL
Return all PractitionerRole resources for Practitioner with an id of 1, the format of the response body will be xml. Replace 'baseUrl' with the actual base Url of the FHIR Server.curl -X GET -H 'Accept: application/fhir+xml' -H 'Authorisation: BEARER [token]' -v 'https://data.developer.nhs.uk/ccri-fhir/STU3/PractitionerRole?practitioner=1'
3.2 Explore the Response
Explore the response in XML & JSON on the Reference Implementation below
Reference Implementation
XML Practitioner id search RI viewer
JSON Practitioner id search RI viewer