Practitioner
Overview
The Practitioner resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers.
Not all practitioners have access to the electronic health record (EHR) but can be referenced by other resources to indicate that they are in some way involved in a patient’s care.
-
This resource supports the following HL7 FHIR US Core Implementation Guide STU 6.1.0 profiles:
Note: Provider’s location and contact information can be found using practitioner.Address and practitioner.Telecom
The following fields are returned if valued:
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Terminology Bindings
Practitioner.identifier.type |
|
Practitioner.qualification.code |
|
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
is-physician |
boolean |
Indicates whether the practitioner is a physician. |
Search
Search for practitioners that meet supplied query parameters.
GET /Practitioner?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Conditionally | token |
The logical resource ID associated with the resource. This parameter is required if identifier , family , name , or active is not used. Example: 12345
|
identifier |
Conditionally | token |
The practitioner identifier. This parameter is required if _id , family , name , or active is not used. |
family |
Conditionally | string |
The start of the family name of the practitioner. This parameter is required if _id , identifier , name , or active is not used. Example: Smith
|
name |
Conditionally | string |
The start of the given name or the family name of the practitioner. This parameter is required if _id , identifier , family, or active is not used. Example: Riley
|
active |
Conditionally | token |
The indication of whether this practitioner’s record is in active use. This parameter is required if _id , identifier , family , or name is not used. Example: active=true
|
given |
No | string |
The start of the given name of the practitioner. Example: John
|
_count |
No | number |
The number of results per page. |
Notes:
- The
identifier
query parameter must include both a system and a code.- Example:
http://hl7.org/fhir/sid/us-npi|4326587548
- Example:
- If the
given
parameter is provided, thefamily
parameter is required. - The
name
parameter must have at least two characters. - The
active
query parameter must not include a system, and the code must betrue
orfalse
. Example:active=false
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-npi%7C1111111111
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "7ec264d2-c7c7-49b2-8478-22351c82db73",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-npi%7C1111111111"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/4122622",
"resource": {
"resourceType": "Practitioner",
"id": "4122622",
"meta": {
"versionId": "20",
"lastUpdated": "2023-11-08T20:50:26.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Cerner Test, Physician - Hospitalist Cerner</p><p><b>Identifiers</b>: NPI: 1111111111</p><p><b>Gender</b>: Other</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"valueBoolean": true,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
}
],
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "NPI",
"display": "National provider identifier"
}
],
"text": "National Provider Identifier"
},
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "1111111111",
"period": {
"start": "2015-10-14T05:00:00.000Z"
}
}
],
"active": true,
"name": [
{
"use": "usual",
"text": "Cerner Test, Physician - Hospitalist Cerner",
"family": "Cerner Test",
"given": [
"Physician - Hospitalist",
"Cerner"
],
"period": {
"start": "2015-09-22T20:58:42.000Z"
}
}
],
"telecom": [
{
"system": "phone",
"value": "5555550001",
"use": "work"
}
],
"address": [
{
"use": "billing",
"text": "1989 Cornelia St\\nKansas City, MO 64012\\nUS",
"line": [
"1989 Cornelia St"
],
"city": "Kansas City",
"district": "Jackson",
"state": "MO",
"postalCode": "64012",
"country": "US"
},
{
"use": "work",
"text": "1234 Main\\nKansas City, MO 64111\\nUS",
"line": [
"1234 Main"
],
"city": "Kansas City",
"state": "MO",
"postalCode": "64111",
"country": "US"
}
],
"gender": "other",
"qualification": [
{
"code": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
"code": "677018",
"display": "AMA",
"userSelected": true
}
],
"text": "AMA"
},
"period": {
"start": "2016-11-08T06:00:00.000Z"
}
}
]
}
}
]
}
Retrieve by ID
List an individual practitioner by their ID.
GET /Practitioner/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/4122622
Response
Status: 200 OK
{
"resourceType": "Practitioner",
"id": "4122622",
"meta": {
"versionId": "20",
"lastUpdated": "2023-11-08T20:50:26.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Cerner Test, Physician - Hospitalist Cerner</p><p><b>Identifiers</b>: NPI: 1111111111</p><p><b>Gender</b>: Other</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"valueBoolean": true,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
}
],
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "NPI",
"display": "National provider identifier"
}
],
"text": "National Provider Identifier"
},
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "1111111111",
"period": {
"start": "2015-10-14T05:00:00.000Z"
}
}
],
"active": true,
"name": [
{
"use": "usual",
"text": "Cerner Test, Physician - Hospitalist Cerner",
"family": "Cerner Test",
"given": [
"Physician - Hospitalist",
"Cerner"
],
"period": {
"start": "2015-09-22T20:58:42.000Z"
}
}
],
"telecom": [
{
"system": "phone",
"value": "5555550001",
"use": "work"
}
],
"address": [
{
"use": "billing",
"text": "1989 Cornelia St\\nKansas City, MO 64012\\nUS",
"line": [
"1989 Cornelia St"
],
"city": "Kansas City",
"district": "Jackson",
"state": "MO",
"postalCode": "64012",
"country": "US"
},
{
"use": "work",
"text": "1234 Main\\nKansas City, MO 64111\\nUS",
"line": [
"1234 Main"
],
"city": "Kansas City",
"state": "MO",
"postalCode": "64111",
"country": "US"
}
],
"gender": "other",
"qualification": [
{
"code": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
"code": "677018",
"display": "AMA",
"userSelected": true
}
],
"text": "AMA"
},
"period": {
"start": "2016-11-08T06:00:00.000Z"
}
}
]
}
Create
Create an individual practitioner that can be referenced by other resources. This API is not used for user provisioning.
POST /Practitioner
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
name
|
Yes |
HumanName |
|
|
|||
identifier
|
No |
List of Identifier |
|
|
|||
active
|
No |
boolean |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner
Body
{
"resourceType": "Practitioner",
"active": true,
"name": [
{
"family": "Williams",
"given": [
"Rory",
"James"
],
"prefix": [
"Dr."
],
"suffix": [
"M.D."
],
"period": {
"start": "2019-12-01T00:00:00.000Z"
}
}
],
"identifier": [
{
"type": {
"coding": [
{
"code": "DEA",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
]
},
"system": "urn:oid:2.16.840.1.113883.4.814",
"value": "CW1234563",
"period": {
"start": "2019-12-01T00:00:00.000Z",
"end": "2029-12-01T23:59:59.000Z"
}
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: application/fhir+json Date: Mon, 09 Dec 2019 18:57:39 GMT Etag: W/"0" Last-Modified: Mon, 09 Dec 2019 18:57:39 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/7118008 Vary: Origin X-Request-Id: 9d3aecfa-c846-4ce2-825a-7ba2fce4813f opc-request-id: /D14ABE620D8D0DBB4D5970966EED037B/6A781B5941C550741C19E1AE1E795C33