Practitioner
Overview
The Practitioner resource provides information about a person formally involved in the care of a patient on behalf of a health care facility.
Soarian Clinicals® supports a read-only Application Programming Interface (API). This API accepts GET
and POST
based search and GET
based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals® at the time of the query.
The search results include the following fields if they contain values:
Search
Search for Practitioner resources that meet specified query parameters:
GET /Practitioner?:parameters
Implementation Notes
- 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.
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This, or any other required search parameter | token |
The logical resource ID associated with the resource. |
identifier |
This, or any other required search parameter | token |
A practitioner identifier alias. Example: http://hl7.org/fhir/sid/us-npi|4326587548
|
name |
This, or any other required search parameter | string |
The start of either the family or the given name of the Practitioner. Example: Smith
|
family |
This, or any other required search parameter | string |
The start of the practitioner’s family name. Example: Smith
|
given |
This, or any other required search parameter | string |
The start of the practitioner’s given name. Example: Jane
|
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Practitioner?_id=DF2821C049CC47E6A37C6B796DF4CF1D
Response
Status: 200 OK
{
"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<br /><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"
}
]
}
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.
- In addition, a
422 Unprocessable Entity
HTTP response status code and OperationOutcome is returned when more than 499 Practitioners qualify for the search criteria.
Retrieve by ID
List an individual Practitioner resource by its resource ID:
GET /Practitioner/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D
Response
Status: 200 OK
{
"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<br /><b>Status</b>:Active<br /><b>Identifier:</b><b>System</b>:http://hl7.org/fhir/sid/us-npi,<b>Value</b>:7051690262<br /></div>"
}
}
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.