Patient
Overview
The Patient resource provides general demographic information about a person receiving health care services from a specific organization. Common demographic fields include patient id, patient name, gender, date of birth, address, phone, primary language and marital status. Cerner Millennium is a patient centric application: thus, many of the other resources will include the patient id in their queries. A person receiving care from multiple organizations may have data available in multiple patient resources in multiple FHIR servers.
The following fields are returned if valued:
- Patient name
- Patient id
- Extensions including birth time, birth sex, ethnicity, and race
- Medical Record number (MRN)
- Contact information (may include phone and email)
- Contact person (guardian, parent or emergency)
- Gender (administrative)
- Date of Birth
- Deceased
- Address
- Communication (preferred language)
- Marital status
- Primary Care Providers
- Multiple Birth Information
Terminology Bindings
Patient.identifier.type |
|
Patient.contact.relationship |
|
Extensions
Search
Search for Patients that meet supplied query parameters:
GET /Patient?:parameters
Implementation Notes
- The Patient.animal modifier element is not supported and will not be returned.
- Direct secure email will not be returned.
- If the current user is a patient or patient proxy, a search may be performed without providing any parameters. The search will return all patients the current user has been granted access to view.
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 and/or any other search param, or _id
|
token |
A patient identifier. Example: urn:oid:1.1.1.1.1.1|1022228
|
name |
This and/or any other search param, or _id
|
string |
The start of either family or given name of the patient. Example: Pete
|
family |
This and/or any other search param, or _id
|
string |
The start of the family name of the patient. Example: Adam
|
given |
This and/or any other search param, or _id
|
string |
The start of the given name of the patient. Example: Tim
|
birthdate |
This and/or any other search param, or _id
|
date |
The patient’s date of birth. Example: 1961-01-16
|
phone |
This and/or any other search param, or _id
|
token |
The patient’s phone number. Example: 1111111111
|
email |
This and/or any other search param, or _id
|
token |
The patient’s email address. Example: example@example.com
|
address-postalcode |
This and/or any other search param, or _id
|
string |
The postal code in the address details of the patient. Example: 11111
|
gender |
No | token |
The gender of the patient. Example: male
|
_count |
No | number |
The maximum number of results to return. Defaults to 20 . |
Notes:
- Either the
_id
, or a combination ofidentifier
,birthdate
,name
,given
,family
,address-postalcode
,phone
, oremail
parameters must be provided. - The
gender
parameter may only be provided if at least one ofidentifier
,birthdate
,name
,given
,family
,address-postalcode
,phone
, oremail
parameters is provided. - The
name
,family
, andgiven
parameters support the ‘:exact’ modifier and will search for current names only. - It is not recommended to combine
family
orgiven
parameters withname
parameter when searching for a patient. Whenever possible use the ‘:exact’ modifier. - The
address-postalcode
parameter supports the:exact
modifer. - The
identifier
,name
,family
,given
,phone
,email
,address-postalcode
, orgender
parameters may be provided exactly once and may have only a single value. - The
birthdate
parameter may be provided twice to indicate a date range, but must contain the inclusive prefixes ‘le’ and ‘ge’ - The
birthdate
parameter may be provided once with the following prefixes: ‘ge’, ‘le’, ‘gt’, ‘lt’, ‘eq’
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "917b3535-59c9-4b9d-b5bd-604eccb6aaee",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067",
"resource": {
"resourceType": "Patient",
"id": "12724067",
"meta": {
"versionId": "6",
"lastUpdated": "2020-03-30T19:43:17.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Race",
"code": "2106-3",
"display": "White",
"userSelected": false
}
},
{
"url": "detailed",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Race",
"code": "2106-3",
"userSelected": false
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Ethnicity",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
}
},
{
"url": "detailed",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Ethnicity",
"code": "2186-5",
"userSelected": false
}
},
{
"url": "text",
"valueString": "Not Hispanic, Latino, or Spanish Origin"
}
]
}
],
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/v2/0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6931",
"_value": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
"valueString": "00000006931"
}
]
},
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"active": true,
"name": [
{
"use": "official",
"text": "SMART, JOE",
"family": [
"SMART"
],
"given": [
"JOE"
],
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"telecom": [
{
"system": "phone",
"value": "8168888886",
"use": "home",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"gender": "male",
"birthDate": "1976-04-29",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"text": "12345 Main St\\nKansas city, MO 64116\\nUS",
"line": [
"12345 Main St"
],
"city": "Kansas city",
"district": "Jackson",
"state": "MO",
"postalCode": "64116",
"country": "US",
"period": {
"start": "2019-12-26T15:13:36.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"careProvider": [
{
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
}
]
}
}
]
}
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
will be returned when too many (>1000) patients qualify for the search criteria.
Retrieve by id
List an individual Patient by its id:
GET /Patient/:id
Implementation Notes
- The Patient.animal modifier element is not supported and will not be returned.
- Direct secure email will not be returned.
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067
Response
Status: 200 OK
{
"resourceType": "Patient",
"id": "12724067",
"meta": {
"versionId": "6",
"lastUpdated": "2020-03-30T19:43:17.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Race",
"code": "2106-3",
"display": "White",
"userSelected": false
}
},
{
"url": "detailed",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Race",
"code": "2106-3",
"userSelected": false
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Ethnicity",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
}
},
{
"url": "detailed",
"valueCoding": {
"system": "http://hl7.org/fhir/v3/Ethnicity",
"code": "2186-5",
"userSelected": false
}
},
{
"url": "text",
"valueString": "Not Hispanic, Latino, or Spanish Origin"
}
]
}
],
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/v2/0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6931",
"_value": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
"valueString": "00000006931"
}
]
},
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"active": true,
"name": [
{
"use": "official",
"text": "SMART, JOE",
"family": [
"SMART"
],
"given": [
"JOE"
],
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"telecom": [
{
"system": "phone",
"value": "8168888886",
"use": "home",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
}
],
"gender": "male",
"birthDate": "1976-04-29",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"text": "12345 Main St\\nKansas city, MO 64116\\nUS",
"line": [
"12345 Main St"
],
"city": "Kansas city",
"district": "Jackson",
"state": "MO",
"postalCode": "64116",
"country": "US",
"period": {
"start": "2019-12-26T15:13:36.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"careProvider": [
{
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
}
]
}
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.
Patient Combines Example
Cerner Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This is known as a “patient combine”. If necessary, this merging can later be undone by performing a “patient uncombine”. When the requested patient record has been combined into another record, an inactive Patient entry will be returned which has a link to the current Patient entry. Entries for combined patients will only be returned when retrieving the entries directly by id. They will not be returned when searching with other parameters.
The ability to perform patient combine or uncombine operations is not available through the Cerner Ignite platform.
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742633
Response
Status: 200 OK
{
"resourceType": "Patient",
"id": "12742633",
"meta": {
"versionId": "0"
},
"text": {
"status": "generated",
"div": "<div><p><b>Patient</b></p><p><b>Replaced By</b>: Patient/12724067</p><p><b>Status</b>: Inactive</p></div>"
},
"active": false,
"_gender": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}
]
},
"link": [
{
"other": {
"reference": "Patient/12724067"
},
"type": "replace"
}
]
}
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.
Create
Create an individual Patient:
POST /Patient
Implementation Notes
- The following elements are not supported and will cause an error to be returned if set:
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/json+fhir
Content-Type: application/json+fhir
Body Fields
Notes:
- Birth Sex may be recorded as an extension.
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
identifier
|
Yes |
List of Identifier |
|
|
|||
active
|
No |
boolean |
|
|
|||
name
|
Yes |
List of HumanName |
|
|
|||
telecom
|
No |
List of ContactPoint |
|
|
|||
gender
|
No |
code |
|
|
|||
birthDate
|
No |
date |
|
|
|||
address
|
No |
List of Address |
|
|
|||
maritalStatus
|
No |
CodeableConcept |
|
|
|||
communication
|
No |
BackboneElement |
|
|
|||
careProvider
|
No |
List of Reference |
|
|
|||
Birth Sex Extension
|
No |
Extension |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient
Body
{
"resourceType": "Patient",
"identifier": [
{
"assigner": {
"reference": "Organization/685844"
}
}
],
"active": true,
"name": [
{
"use": "official",
"family": [
"Wolf"
],
"given": [
"Person",
"Name"
],
"period": {
"start": "2010-05-17T14:54:31.000Z"
}
},
{
"use": "usual",
"given": [
"Bigby"
],
"period": {
"start": "2012-05-22T15:45:50.000Z"
}
}
],
"telecom": [
{
"system": "phone",
"value": "8168229121",
"use": "home",
"period": {
"start": "2012-05-17T15:33:18.000Z"
}
}
],
"gender": "male",
"birthDate": "1990-09-15",
"address": [
{
"use": "home",
"line": [
"121212 Metcalf Drive",
"Apartment 403"
],
"city": "Kansas City",
"district": "Jackson",
"state": "KS",
"postalCode": "64199",
"country": "United States of America",
"period": {
"start": "2012-05-17T15:33:18.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/NullFlavor",
"code": "UNK",
"display": "Unknown"
}
],
"text": "Unknown"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English"
}
],
"text": "English"
},
"preferred": true
}
],
"careProvider": [
{
"reference": "Practitioner/4122622"
}
]
}
Response
Status: 201 Created
Date: Tue, 27 Feb 2018 16:47:59 GMT Cache-Control: no-cache Vary: Origin,User-Agent,Accept-Encoding Strict-Transport-Security: max-age=631152000 X-Xss-Protection: 1; mode=block Pragma: no-cache X-Request-Id: 78a19072002b8651623351cfedaffe70 Etag: W/"0" X-Frame-Options: SAMEORIGIN X-Content-Type-Options: nosniff Expires: Mon, 01 Jan 1990 00:00:00 GMT Last-Modified: Tue, 27 Feb 2018 16:48:00 GMT Location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/4842008 Content-Length: 0 Content-Type: application/json
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
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.