Patient
Overview
The Patient resource provides general demographic information about a person receiving healthcare services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone, primary language, and marital status. Millennium is a patient-centric application; thus, many other resources include the patient ID in their queries. A person receiving care from multiple organizations may have information available in multiple patient resources in multiple FHIR servers.
The following fields are returned if valued:
- Patient ID
- Name
- Extension
- Identifier
- Telecom
- Contact
- Gender
- Date of Birth
- Deceased
- Address
- Communication language
- Marital status
- Care Provider
- Multiple Birth
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
Patient.identifier.type |
|
Patient.contact.relationship |
|
Extensions
Search
Search for patients who meet supplied query parameters.
GET /Patient?:parameters
Notes
- The Patient.animal modifier element is not supported and not returned.
- Direct secure email is not returned.
- If the current user is a patient or patient proxy, a search may be performed without providing any parameters. The search returns all patients that the current user is granted access to view.
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Conditionally | token |
The logical resource ID associated with the resource. This parameter is required if at least one of the following parameters is not used: identifier , name , family , given , birthdate , phone , email , or address-postalcode . Example: 11111111
|
identifier |
Conditionally | token |
A patient identifier. This parameter is required if _id , name , family , given , birthdate , phone , email , and address-postalcode are not used. Example: urn:oid:1.1.1.1.1.1\|1022228
|
name |
Conditionally | string |
The start of the family or given name of the patient. This parameter is required if _id , identifier , family , given , birthdate , phone , email , and address-postalcode are not used. Example: Pete
|
family |
Conditionally | string |
The start of the family name of the patient. This parameter is required if _id , identifier , name , given , birthdate , phone , email , and address-postalcode are not used. Example: Adam
|
given |
Conditionally | string |
The start of the given name of the patient. This parameter is required if _id , identifier , name , family , birthdate , phone , email , and address-postalcode are not used. Example: Tim
|
birthdate |
Conditionally | date |
The patient’s date of birth. This parameter is required if _id , identifier , name , family , given , phone , email , and address-postalcode are not used. Example: 1961-01-16
|
phone |
Conditionally | token |
The patient’s phone number. This parameter is required if _id , identifier , name , family , given , birthdate , email , and address-postalcode are not used. Example: 1111111111
|
email |
Conditionally | token |
The patient’s email address. This parameter is required if _id , identifier , name , family , given , birthdate , phone , and address-postalcode are not used. Example: example@example.com
|
address-postalcode |
Conditionally | string |
The postal code in the address details of the patient. This parameter is required if _id , identifier , name , family , given , birthdate , phone , and email are not used. Example: 11111
|
gender |
No | token |
The administrative gender of the patient. Example: male
|
_count |
No | number |
The maximum number of results to return. Defaults to 20 . |
Notes
- The
name
,family
, andgiven
parameters support the:exact
modifier and search for current names only, based on the name’speriod
. - We do not recommend combining
family
orgiven
parameters with thename
parameter when searching for a patient. Whenever possible, use the:exact
modifier. - The
address-postalcode
parameter supports the:exact
modifier. - 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 in the following formats:- Once with a prefix of
ge
,le
,gt
,lt
, oreq
. Example:birthdate=ge2001-03-13
- Twice to indicate a date range and must contain one prefix each of
le
andge
. Example:birthdate=ge2001-03-13&birthdate=le2001-05-01
- Once with a prefix of
- A
422 - Unprocessable Entity
is returned when over 1,000 patients qualify for the search criteria.
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"
}
]
}
}
]
}
Retrieve by ID
List an individual patient by their ID.
GET /Patient/:id
Notes
- The Patient.animal modifier element is not supported and not returned.
- Direct secure email is not 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"
}
]
}
Patient Combine Example
Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This action is known as a patient combine. If necessary, a patient uncombine can undo this merging. When the requested patient record is combined into another record, an inactive patient entry is returned with a link to the current patient entry. Entries for combined patients are only returned when retrieving the entries directly by ID. They are not returned when searching with other parameters.
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"
}
]
}
Create
Create an individual patient.
POST /Patient
Notes
- The following elements are not supported and return an error 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 |
|
|
|||
name
|
Yes |
List of HumanName |
|
|
|||
active
|
No |
boolean |
|
|
|||
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/MaritalStatus",
"code": "S",
"display": "Never Married"
}
],
"text": "Single"
},
"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: f17bbd99-f89b-4cfe-8425-43b14e5735cf opc-request-id: /5E94C5FFC27CDD51DB70C0F464E44A96/AECA8B137DC613A323E70B1ED7C53808 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.