Patient
- Overview
- Terminology Bindings
- Extensions
- Search
- Retrieve by ID
- Create
- Patch
- Operation: $health-cards-issue
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. Additional concepts returned as extensions and not part of the base resource include time of birth, preferred contact, race, ethnicity, and birth sex. 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.
-
This resource supports the following US Core Implementation Guide profiles:
The following fields are returned if valued:
- Patient ID
- Identifiers
- Active
- Name
- Telecom
- Gender
- Extensions
- Date of Birth
- Deceased
- Address
- Marital status
- Multiple Birth information
- Contact person
- Communication
- Primary Care Providers
Notes
- Direct secure email is not returned.
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.maritalStatus |
|
Patient.contact.relationship |
|
Patient.communication.language |
|
Extensions
- Patient Birth Time
- Patient Preferred Contact
- US Core Race
- US Core Ethnicity
- US Core Birth Sex
- Communication Preference
Search
Search for patients who meet supplied query parameters.
GET /Patient?:parameters
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 . |
_revinclude |
No | token |
The Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target
|
Notes
- A
422 Unprocessable Content
status code is returned when more than 1,000 patients qualify for the search criteria. - 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 the
family
orgiven
parameters with thename
parameter when searching for a patient. Whenever possible, use 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 once using one of the following prefixes to imply a date range:
ge
,le
,gt
,lt
, oreq
. - May be provided twice to indicate a date range and must contain one prefix each of
le
andge
. Example:birthdate=ge2001-03-13&birthdate=le2001-05-01
- Must not be provided with a time component.
- May be provided once using one of the following prefixes to imply a date range:
- The
identifier
parameter- Requires a code, but the system is optional. If the system is not provided, the search is performed across all systems supported by the Patient resource.
- Searches against the specific system, if it is provided.
- Accepts a Social Security Number (SSN), but the value is not returned in a matching response.
- The
_revinclude
parameter- May be provided once with the value of
Provenance:target
. Example:_revinclude=Provenance:target
- Requires the OAuth2 token to include the Provenance scope corresponding to the current Patient scope, such as
user/Provenance.read
,patient/Provenance.read
, orsystem/Provenance.read
.
- May be provided once with the value of
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?family=smart&given=joe&birthdate=1990-09-15
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "b8e08a98-849f-4544-9fa8-985aa445e31b",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067",
"resource": {
"resourceType": "Patient",
"id": "12724067",
"meta": {
"versionId": "10",
"lastUpdated": "2020-07-06T21:21:22.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"id": "59434424",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
"code": "485602703",
"display": "Appointment Reminders",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/communication-topic",
"code": "appointment-reminder",
"display": "Appointment Reminder",
"userSelected": false
}
],
"text": "Appointment Reminders"
},
"url": "communication-type"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
"code": "495085513",
"display": "Fax",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-system",
"code": "fax",
"display": "Fax",
"userSelected": false
}
],
"text": "Fax"
},
"url": "contact-method"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
"code": "163",
"display": "Business",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-use",
"code": "work",
"display": "Work",
"userSelected": false
}
],
"text": "Business"
},
"url": "contact-type"
},
{
"valueDateTime": "2019-04-13T20:00:00.000Z",
"url": "verified-datetime"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"id": "CI-490016886-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6931",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490058771-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6978",
"period": {
"end": "2020-07-06T21:21:25.000Z"
}
},
{
"id": "CI-490059574-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "3C36293A3B964994AD8E6C0305F3330A",
"period": {
"start": "2020-06-30T20:08:26.000Z"
}
},
{
"id": "CI-490058805-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "43DA797A657B47548F258A9B50EB41F5",
"period": {
"start": "2020-06-12T16:03:32.000Z"
}
},
{
"id": "CI-490059570-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:AN7TD9A62CV8Z53Z",
"period": {
"start": "2020-06-30T20:08:25.000Z"
}
},
{
"id": "CI-490058801-6",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:KR8KC9MI9EQ8KC23",
"period": {
"start": "2020-06-12T16:03:29.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12724067-0",
"use": "official",
"text": "SMART, JOE",
"family": "SMART",
"given": [
"JOE"
],
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490059796-0",
"use": "old",
"text": "SMART, STEPHEN ALLEN",
"family": "SMART",
"given": [
"STEPHEN",
"ALLEN"
],
"period": {
"end": "2020-07-06T21:21:26.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29811920-0",
"extension": [
{
"valueUrl": "(816)888-8886",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "12345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "8168888886",
"use": "home",
"rank": "1",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-EM-29822662-0",
"system": "email",
"value": "joesmart@yopmail.com",
"use": "home",
"rank": "1",
"period": {
"start": "2020-03-30T19:31:11.000Z"
}
}
],
"gender": "male",
"birthDate": "1976-04-29",
"deceasedBoolean": false,
"address": [
{
"id": "CI-24313553-0",
"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": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490017023-0",
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
}
]
}
}
]
}
Example with RevInclude
Authorization Types
Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=629928&_revinclude=Provenance:target
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "65ee4c79-3514-4eab-b606-10ad56fb0d5d",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=629928&_revinclude=Provenance%3Atarget"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/629928",
"resource": {
"resourceType": "Patient",
"id": "629928",
"meta": {
"versionId": "36",
"lastUpdated": "2020-09-17T16:35:12.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: England,\n Brad N</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Jan 20, 1999</p>\n <p><b>Administrative Gender</b>: Unknown</p></div>"
},
"identifier": [
{
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
],
"active": true,
"name": [
{
"id": "CI-629928-0",
"use": "official",
"text": "England, Brad N",
"family": "England",
"given": [
"Brad",
"N"
],
"period": {
"start": "2004-01-27T00:00:00.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-46477780-0",
"extension": [
{
"valueUrl": "2232323",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "2232323",
"rank": 1,
"period": {
"start": "2021-01-11T06:00:00.000Z"
}
},
{
"id": "CI-PH-9543543-1",
"extension": [
{
"valueUrl": "1234567890",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "1234567890",
"use": "home",
"rank": 1,
"period": {
"start": "2014-01-20T15:48:39.000Z",
"end": "2014-03-20T15:48:39.000Z"
}
},
{
"id": "CI-PH-9543573-2",
"extension": [
{
"valueUrl": "1234567890",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "1234567890",
"use": "home",
"rank": 1,
"period": {
"start": "2014-01-20T15:48:39.000Z",
"end": "2014-03-20T15:48:39.000Z"
}
}
],
"gender": "unknown",
"birthDate": "1999-01-20",
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
"code": "83266815",
"display": "Authorized Representative",
"userSelected": true
}
],
"text": "Authorized Representative"
}
],
"name": {
"id": "CI-170778458-0",
"use": "official",
"text": "MARSTON, Dutch",
"family": "MARSTON",
"given": [
"Dutch"
],
"period": {
"start": "2020-08-26T14:44:08.000Z"
}
},
"telecom": [
{
"system": "email",
"value": "kaishwaryaramesh@gmail.com",
"use": "home",
"rank": 1,
"period": {
"start": "2020-10-09T07:29:32.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 2,
"period": {
"start": "2020-08-26T14:45:59.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 3,
"period": {
"start": "2020-08-26T16:47:31.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 4,
"period": {
"start": "2020-08-27T20:27:31.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 5,
"period": {
"start": "2020-08-28T15:24:19.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 6,
"period": {
"start": "2020-08-31T15:16:18.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 7,
"period": {
"start": "2020-09-10T20:41:05.000Z"
}
},
{
"system": "email",
"value": "abigail.testpatient@gmail.com",
"use": "home",
"rank": 8,
"period": {
"start": "2020-09-11T15:52:04.000Z"
}
}
],
"gender": "male",
"period": {
"start": "2020-08-27T20:27:31.000Z"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/ptntdemo-17390433",
"resource": {
"resourceType": "Provenance",
"id": "ptntdemo-17390433",
"meta": {
"versionId": "17390433",
"lastUpdated": "2021-06-03T11:18:59Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p>\n <p><b>Target</b>:</p><ul><li>Patient/629928</li></ul>\n <p><b>Recorded</b>: Jun 3, 2021 6:18 A.M. CDT</p>\n <p><b>Agents</b>:</p><dl><dt>organizationName PrH</dt>\n <dd><b>Agent Type</b>: Author</dd>\n <dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-68607</p></div>"
},
"target": [
{
"reference": "Patient/629928"
}
],
"recorded": "2021-06-03T11:18:59Z",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Organization/59917604",
"display": "organizationName PrH"
}
}
],
"entity": [
{
"role": "source",
"what": {
"reference": "DocumentReference/S-68607"
}
}
]
},
"search": {
"mode": "include"
}
}
]
}
Retrieve by ID
List an individual patient by their ID.
GET /Patient/: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/Patient/12724067
Response
Status: 200 OK
{
"resourceType": "Patient",
"id": "12724067",
"meta": {
"versionId": "10",
"lastUpdated": "2020-07-06T21:21:22.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"id": "59434424",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
"code": "485602703",
"display": "Appointment Reminders",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/communication-topic",
"code": "appointment-reminder",
"display": "Appointment Reminder",
"userSelected": false
}
],
"text": "Appointment Reminders"
},
"url": "communication-type"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
"code": "495085513",
"display": "Fax",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-system",
"code": "fax",
"display": "Fax",
"userSelected": false
}
],
"text": "Fax"
},
"url": "contact-method"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
"code": "163",
"display": "Business",
"userSelected": true
},
{
"system": "http://hl7.org/fhir/contact-point-use",
"code": "work",
"display": "Work",
"userSelected": false
}
],
"text": "Business"
},
"url": "contact-type"
},
{
"valueDateTime": "2019-04-13T20:00:00.000Z",
"url": "verified-datetime"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"id": "CI-490016886-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6931",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490058771-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "6978",
"period": {
"end": "2020-07-06T21:21:25.000Z"
}
},
{
"id": "CI-490059574-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "3C36293A3B964994AD8E6C0305F3330A",
"period": {
"start": "2020-06-30T20:08:26.000Z"
}
},
{
"id": "CI-490058805-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "43DA797A657B47548F258A9B50EB41F5",
"period": {
"start": "2020-06-12T16:03:32.000Z"
}
},
{
"id": "CI-490059570-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:AN7TD9A62CV8Z53Z",
"period": {
"start": "2020-06-30T20:08:25.000Z"
}
},
{
"id": "CI-490058801-6",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:KR8KC9MI9EQ8KC23",
"period": {
"start": "2020-06-12T16:03:29.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12724067-0",
"use": "official",
"text": "SMART, JOE",
"family": "SMART",
"given": [
"JOE"
],
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-490059796-0",
"use": "old",
"text": "SMART, STEPHEN ALLEN",
"family": "SMART",
"given": [
"STEPHEN",
"ALLEN"
],
"period": {
"end": "2020-07-06T21:21:26.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29811920-0",
"extension": [
{
"valueUrl": "(816)888-8886",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
},
{
"valueString": "12345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"system": "phone",
"value": "8168888886",
"use": "home",
"rank": "1",
"period": {
"start": "2019-12-26T15:14:12.000Z"
}
},
{
"id": "CI-EM-29822662-0",
"system": "email",
"value": "joesmart@yopmail.com",
"use": "home",
"rank": "1",
"period": {
"start": "2020-03-30T19:31:11.000Z"
}
}
],
"gender": "male",
"birthDate": "1976-04-29",
"deceasedBoolean": false,
"address": [
{
"id": "CI-24313553-0",
"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": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490017023-0",
"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, you can perform a patient uncombine to 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/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742633
Response
Status: 200 OK
{
"resourceType": "Patient",
"id": "12742633",
"meta": {
"versionId": "0"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Status</b>: Inactive</p><p><b>Replaced By</b>: Patient/12724067</p></div>"
},
"identifier": [
{
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
],
"active": false,
"name": [
{
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
],
"_gender": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"link": [
{
"other": {
"reference": "Patient/12724067"
},
"type": "replaced-by"
}
]
}
Create
Create a new patient.
POST /Patient
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json
Body Fields
Notes
- Only the body fields mentioned below are supported. Unsupported fields are ignored.
- Birth Sex, Ethnicity, and Race may be recorded as extensions.
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 |
List of BackboneElement |
|
|
|||
generalPractitioner
|
No |
List of Reference |
|
|
|||
US Core Birth Sex Extension
|
No |
Extension |
|
|
|||
US Core Ethnicity Extension
|
No |
Extension |
|
|
|||
US Core Race Extension
|
No |
Extension |
|
|
|||
Communication Preference Extension
|
No |
Extension |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient
Body
{
"resourceType": "Patient",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2028-9",
"display": "Asian"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2039-6",
"display": "Japanese"
}
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino"
}
}
]
},
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
"extension": [
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
"code": "485602703",
"display": "Appointment Reminder",
"userSelected": false
}
],
"text": "Appointment Reminder"
},
"url": "communication-type"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
"code": "4054467",
"display": "Phone",
"userSelected": false
}
]
},
"url": "contact-method"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
"code": "163",
"display": "Business",
"userSelected": false
}
],
"text": "Home"
},
"url": "contact-type"
}
],
"verified": "2019-12-26T15:41:52.000Z"
}
]
}
],
"identifier": [
{
"assigner": {
"reference": "Organization/675844"
}
}
],
"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",
"id": "CI-PH-29811920-0",
"extension": [
{
"valueString": "12345",
"url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
}
],
"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://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "UNK",
"display": "Unknown"
}
],
"text": "Unknown"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English"
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"reference": "Practitioner/4122622"
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Wed, 27 Mar 2019 17:23:14 GMT Etag: W/"0" Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/5786010 Last-Modified: Wed, 27 Mar 2019 17:23:14 GMT Vary: Origin X-Request-Id: 6aa99cae-2ee5-4529-8cb2-1aa73f818207 opc-request-id: /4B7BCF043117301F1B647EF553C7F250/A326F573558AD7570F63BFC19D88739A
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Patch
Patch an existing patient.
PATCH /Patient/:id
Notes
- This implementation follows RFC 6902 JSON Patch.
- Only operations on the paths listed below are supported.
- When a path includes
{index}
, it refers to the index of the element in the list of elements. - All indexes are 0 based.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/json-patch+json
If-Match: W/"<Current version of the Patient resource>"
Patch Operations
Path | Operation | Value Type | |
---|---|---|---|
/identifier/-
|
add |
Identifier |
|
|
|||
/identifier/{index}/id
|
test |
string |
|
|
|||
/identifier/{index}
|
remove |
N /A |
|
|
|||
/identifier/{index}/system
|
replace |
uri |
|
|
|||
/identifier/{index}/value
|
replace |
string |
|
|
|||
/identifier/{index}/period
|
replace |
Period |
|
|
|||
/name/{index}/id
|
test |
string |
|
|
|||
/name/{index}/family
|
replace |
String |
|
|
|||
/name/{index}/given
|
replace |
String |
|
|
|||
/name/{index}/prefix
|
replace |
String |
|
|
|||
/name/{index}/suffix
|
replace |
String |
|
|
|||
/name/{index}/period
|
replace |
Period |
|
|
|||
/telecom/-
|
add |
ContactPoint |
|
|
|||
/telecom/{index}/id
|
test |
string |
|
|
|||
/telecom/{index}
|
remove |
N /A |
|
|
|||
/telecom/{index}/value
|
replace |
string |
|
|
|||
/telecom/{index}/rank
|
replace |
positiveInt |
|
|
|||
/telecom/{index}/extension
|
replace |
Extension |
|
|
|||
/telecom/{index}/period
|
replace |
Period |
|
|
|||
/gender
|
replace |
code |
|
|
|||
/birthDate
|
replace |
date |
|
|
|||
/address/-
|
add |
Address |
|
|
|||
/address/{index}/id
|
test |
string |
|
|
|||
/address/{index}
|
remove |
N /A |
|
|
|||
/address/{index}/line
|
replace |
string |
|
|
|||
/address/{index}/city
|
replace |
string |
|
|
|||
/address/{index}/district
|
replace |
string |
|
|
|||
/address/{index}/state
|
replace |
string |
|
|
|||
/address/{index}/postalCode
|
replace |
string |
|
|
|||
/address/{index}/country
|
replace |
string |
|
|
|||
/address/{index}/period
|
replace |
Period |
|
|
|||
/maritalStatus
|
replace |
CodeableConcept |
|
|
|||
/communication
|
replace |
BackboneElement |
|
|
|||
/generalPractitioner/-
|
add |
Reference |
|
|
|||
/generalPractitioner/{index}/id
|
test |
string |
|
|
|||
/generalPractitioner/{index}
|
remove |
N /A |
|
|
|||
/extension
|
replace |
Extension |
|
|
|||
/extension/{index}/id
|
test |
string |
|
|
|||
/extension/{index}
|
remove |
N /A |
|
|
|||
/extension/-
|
add |
Communication Preference |
|
|
|||
/extension/{index}
|
replace |
Communication Preference |
|
|
Example
Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067
Body
[
{
"op": "add",
"path": "/identifier/-",
"value": {
"type": {
"coding": [
{
"code": "MR",
"system": "http://hl7.org/fhir/v2/0203"
}
]
},
"system": "2.16.840.1.113883.6.1000",
"value": "THIS:IS:A:UNIQUE:IDENTIFIER",
"period": {
"start": "2018-01-02T00:00:00-05:00",
"end": "2022-01-02T00:00:00-05:00"
}
}
},
{
"path": "/name/0/id",
"op": "test",
"value": "CI-12724067-0"
},
{
"path": "/name/0/given",
"op": "replace",
"value": [
"Joe",
"Smarty"
]
},
{
"path": "/telecom/0/id",
"op": "test",
"value": "CI-PH-29811920-0"
},
{
"path": "/telecom/0",
"op": "remove"
},
{
"path": "/maritalStatus",
"op": "replace",
"value": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "D"
}
]
}
},
{
"path": "/communication",
"op": "replace",
"value": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151"
}
]
},
"preferred": true
}
]
},
{
"path": "/extension",
"op": "replace",
"value": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2110-5",
"display": "English"
}
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2135-2",
"display": "Hispanic or Latino"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2156-8",
"display": "Costa Rican"
}
}
]
}
]
}
]
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 0 Content-Type: application/fhir+json Date: Wed, 27 Mar 2019 17:23:14 GMT Etag: W/"1" Last-Modified: Wed, 27 Mar 2019 17:23:14 GMT Vary: Origin X-Request-Id: 02352eda-9574-4f23-9ab7-5915d5b09627 opc-request-id: /4B7BCF043117301F1B647EF553C7F250/A326F573558AD7570F63BFC19D88739A
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Operation: $health-cards-issue
Issues Health Cards for an existing patient.
POST /Patient/:id/$health-cards-issue
See Health Cards documentation for more details about this operation.