Gets a list of practitioners
get
/Practitioner
Search for Practitioner resources that meet specified query parameters.
GET /Practitioner?:parameters
This operation supports the following authorization types:
- Provider
- Patient
- System
A 422 Unprocessable Entity
response status code and OperationOutcome are returned when more than 499 Practitioners qualify for the search criteria. Fast Healthcare Interoperability Resources(FHIR) applications may prompt the user for more specific search criteria to avoid this possibility.
Request
Query Parameters
-
_id: string
The logical resource ID associated with the resource.
This parameter is requred unless any other required search parameter is used.
Type: token. -
family: string
The start of the practitioner???s family name. For example,
Smith
This parameter is requred unless any other required search parameter is used.
Type: string. -
given: string
The start of the practitioner???s given name. For example,
Jane
This parameter is requred unless any other required search parameter is used.
Type: string. -
identifier: string
A practitioner identifier alias. For example,
http://hl7.org/fhir/sid/us-npi|432658754
This parameter is requred unless any other required search parameter is used.
Type: token. -
name: string
The start of either the family or the given name of the Practitioner. For example,
Smith
This parameter is requred unless any other required search parameter is used.
Type: string.
Header Parameters
-
Accept(required): string
The media type to be requested. Refer to what the resource's operation produces for what is supported.
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
Response
Supported Media Types
- application/fhir+json
Default Response
Example Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Practitioner?_id=DF2821C049CC47E6A37C6B796DF4CF1D
Example Response:
{
"resourceType": "Bundle",
"id": "a91a2e79-2379-4fdf-b9bd-4aee22fd5162",
"type": "searchset",
"timestamp": "2021-09-30T04:00:27-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D",
"resource": {
"resourceType": "Practitioner",
"id": "DF2821C049CC47E6A37C6B796DF4CF1D",
"meta": {
"lastUpdated": "2021-01-07T13:56:11-05:00"
},
"name": [
{
"use": "official",
"text": "Godziszewski,Janet Kris",
"family": "Godziszewski",
"given": [
"Janet",
"Kris"
],
"suffix": [
"MD"
]
}
],
"active": true,
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "7051690262"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Practitioner</b><br /><b>Practitioner</b>:Godziszewski,Janet Kris
<b>Status</b>:Active<br /><b>Identifier:</b><b>System</b>:http://hl7.org/fhir/sid/us-npi,<b>Value</b>:7051690262<br /></div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Practitioner?_id=DF2821C049CC47E6A37C6B796DF4CF1D&_format=json"
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id
, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id
, if present.