Patient

• Overview
• Terminology Bindings
• Extensions
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example
  • Example with RevInclude
  • Authorization Types
  • Errors
• Retrieve by id
  • Authorization Types
  • Headers
  • Example
  • Patient Combines Example
  • Errors
• Create
  • Authorization Types
  • Headers
  • Body Fields
  • Example
  • Errors
• Patch
  • Authorization Types
  • Headers
  • Patch Operations
  • Example
  • Response
  • Errors
• Operation: $health-cards-issue

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. Additional concepts returned as extensions and not part of the base resource include time of birth, preferred contact, race, ethnicity and birth sex. 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 HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:

  • US Core Patient Profile

The following fields are returned if valued:

• Patient id
• Patient Identifier
• Active
• Patient name
• Telecom Information (may include phone and email)
• Gender (administrative)
• Extensions including birth time, preferred contact, birth sex, ethnicity, communication preference and race
• Date of Birth
• Deceased
  • Boolean
  • dateTime
• Address
• Marital status
• Multiple Birth Information
  • Boolean
  • Integer
• Contact person (guardian, parent or emergency)
• Communication (preferred language)
• Primary Care Providers
  • Reference (Practitioner)

Terminology Bindings

Patient.identifier.type

Description The type used to determine which identifier to use for a specific purpose. Details: Identifier Type Codes System: http://hl7.org/fhir/identifier-type Details: v2 Identifier Type System: http://terminology.hl7.org/CodeSystem/v2-0203 Details: Millennium Person Identifier (Alias) Types System: https://fhir.cerner.com/<EHR source id>/codeSet/4

Patient.maritalStatus

Description The patient's most recent marital (civil) status. Details: Marital Status Codes System: http://hl7.org/fhir/marital-status Details: v3.MaritalStatus System: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Details: v3.NullFlavor System: http://terminology.hl7.org/CodeSystem/v3-NullFlavor Details: Millennium Marital Status System: https://fhir.cerner.com/<EHR source id>/codeSet/38

Patient.contact.relationship

Description The nature of the relationship between a patient and a contact person for that patient. Details: PatientContactRelationship System: http://hl7.org/fhir/patient-contactrelationship Details: v2.0131 System: http://terminology.hl7.org/CodeSystem/v2-0131 Details: Millennium Person Relationship Types System: https://fhir.cerner.com/<EHR source id>/codeSet/351

Patient.communication.language

Description Language which may be used to communicate with the patient about his or her health. Details: CommonLanguages System: http://hl7.org/fhir/languages Details: IETF Identifying Languages System: urn:ietf:bcp:47 Details: Millennium Languages System: https://fhir.cerner.com/<EHR source id>/codeSet/36

Extensions

• Patient Birth Time
• Patient Preferred Contact
• US Core Race
• US Core Ethnicity
• US Core Birth Sex
• Communication Preference

Search

Search for Patients that meet supplied query parameters:

GET /Patient?:parameters

Implementation Notes

• Direct secure email will not be returned.
• Patient.identifier.use will have a value of ‘usual’

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: John
family	This and/or any other search param, or _id	string	The start of the family name of the patient. Example: Smith
given	This and/or any other search param, or _id	string	The start of the given name of the patient. Example: John
birthdate	This and/or any other search param, or _id	date	The patient’s date of birth. Example: 1990-01-01
phone	This and/or any other search param, or _id	token	The patient’s phone number. Example: 1234567891
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: 12345
gender	No	token	The gender of the patient. Example: male
_count	No	number	The maximum number of results to return. Defaults to 20.
_revinclude	No	token	Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target

Notes:

• Either the _id, or a combination of identifier , birthdate, name, given, family, address-postalcode, phone, or email parameters must be provided.
• The gender parameter may only be provided if at least one of identifier , birthdate, name, given, family, address-postalcode, phone, or email parameters is provided.
• The name, family, and given parameters support the ‘:exact’ modifier and will search for current names only.
• It is not recommended to combine family or given parameters with name parameter when searching for a patient. Whenever possible use the ‘:exact’ modifier.
• The identifier, name, family, given, phone, email, address-postalcode, or gender parameters may be provided exactly once and may have only a single value.
• The birthdate parameter
  • May be provided twice using the prefixes le and ge to indicate a date range
  • May be provided once using one of the following prefixes to imply a date range: ge, le, gt, lt, eq
  • Must not be provided with a time component
• The identifier parameter
  • Code details are required. System is optional. If system is not provided, search is performed across all systems supported by the Patient resource.
  • When valid system is provided, search is performed against the specific system.
• The _revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
• The _revinclude parameter may be provided with any required search param. Example: _id=629928&_revinclude=Provenance:target
• When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
• FHIR does not return the SSN. It can be passed in as a query parameter but it won’t come back in the JSON response.

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067

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"
      }
    }
  ]
}

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

• Direct secure email will not be returned.
• Patient.identifier.use will have a value of ‘usual’

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 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/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"
    }
  ]
}

Errors

The common errors and OperationOutcomes may be returned.

Create

Create a new Patient.

POST /Patient

Implementation Notes

• Only the body fields mentioned below are supported. Unsupported fields will be ignored.
• Modifier fields should not be provided, and will cause the transaction to fail.

Authorization Types

Headers

Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json

Body Fields

Notes:

• Birth Sex, Ethnicity, and Race may be recorded as extensions.

Name	Required	Type
resourceType	Yes	string
Description The type of the FHIR resource. Example { "resourceType": "Patient" } Notes resourceType must be Patient. top of section
identifier	Yes	List of Identifier
Description The identifiers for the patient. Example { "identifier": [ { "assigner": { "reference": "Organization/619848" } }, { "type": { "coding": [ { "code": "MR", "system": "http://hl7.org/fhir/v2/0203" } ] }, "system": "urn:oid:1.1.1.1.1.1", "value": "<unique identifier>", "period": { "start": "2016-01-02T00:00:00-05:00", "end": "2020-01-02T00:00:00-05:00" } } ] } Notes At least one identifier must be provided. The provided identifier must meet the following conditions: Must contain only an assigner field with a reference to the Organization in which the patient is being enrolled. Subsequent identifiers may be provided, but have the following constraints: Must not contain the assigner and use fields. Must contain the type, system, and value fields. When specifying a period, must include a time component with a timezone. top of section
active	No	boolean
Description Whether this patient record is in active use. Example { "active": true } Notes If set, value must be true. top of section
name	Yes	List of HumanName
Description The names associated with the individual. Example { "name": [ { "use": "official", "family": "Wolf", "given": [ "Big", "Bad" ], "period": { "start": "2010-05-17T14:54:31.000Z" } }, { "use": "usual", "given": [ "Bigby" ], "period": { "start": "2012-05-22T15:45:50.000Z" } } ] } Notes At least one name must be provided. The provided name must meet the following conditions: Must have a use of 'official'. Must not have an end date on period, or must not include period. Must include both given and family. Each name must include the use field. Each name must contain either the given or family fields. Each name cannot contain the text field. Up to two given names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces. Only one prefix and one suffix may be provided. When specifying a period, the fields must include a time component with a timezone. The family field has a character limit of 100. Each value for the given, prefix, and suffix fields has a character limit of 100. top of section
telecom	No	List of ContactPoint
Description A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. Example { "telecom": [ { "system": "phone", "value": "8168229121", "use": "home", "extension": [ { "valueString": "12345", "url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension" } ], "period": { "start": "2012-05-17T15:33:18.000Z" } } ] } Notes Each telecom must contain the system, use, and value fields. When specifying a period, the fields must include a time component with a timezone. The value and extension.valueString fields have a character limit of 100. When specifying an extension, the system field must be 'phone'. When specifying an extension, the extension.url field must be 'http://hl7.org/fhir/StructureDefinition/contactpoint-extension'. top of section
gender	No	code
Description Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Example { "gender": "male" } top of section
birthDate	No	date
Description The date of birth for the individual. Example { "birthDate": "1990-09-15" } top of section
address	No	List of Address
Description Addresses for the individual. Example { "address": [ { "use": "home", "line": [ "1212 Faircastle Drive", "Apartment 406" ], "city": "KC", "district": "Jackson", "state": "KS", "postalCode": "64199", "country": "United States of America", "period": { "start": "2012-05-17T15:33:18.000Z" } } ] } Notes Each address must contain the use field. Each address should contain at least one of the line, city, district, state, postalCode, country fields, otherwise address will be ignored by the server. Each address must not contain the text field. When specifying a period, the fields must include a time component with a timezone. Each value for the line field has a character limit of 100. The city, district, state, and country fields have a character limit of 100. The postalCode field has a character limit of 25. top of section
maritalStatus	No	CodeableConcept
Description The patient's most recent marital (civil) status. Example { "maritalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "S", "display": "Never Married" } ], "text": "Never Married" } } top of section
communication	No	List of BackboneElement
Description Language which may be used to communicate with the patient about his or her health. Example { "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en", "display": "English" } ], "text": "English" }, "preferred": true } ] } Notes Only one communication may be provided. top of section
generalPractitioner	No	List of Reference
Description Patient's nominated care provider. Example { "generalPractitioner": [ { "reference": "Practitioner/995932" } ] } Notes Must only include references to Practitioners. top of section
US Core Birth Sex Extension	No	Extension
Description The sex of the patient at birth. Example { "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode": "F" } ] } top of section
US Core Ethnicity Extension	No	Extension
Description The ethnicity of the patient. Example { "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" } } ] } top of section
US Core Race Extension	No	Extension
Description The race of the patient. Example { "extension": [ { "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" } } ] } ] } top of section
Communication Preference Extension	No	Extension
Description The communication preference for the patient. Example { "extension": [ { "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" } ], "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference", "verified": "2019-12-26T15:41:52.000Z" } ] } top of section

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: 11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on subsequent updates.

Errors

The common errors and OperationOutcomes may be returned.

Patch

Patch an existing Patient.

PATCH /Patient/:id

Implementation Notes

• This implementation follows the JSON PATCH spec.
• 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. The indexes here 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
Description Add a new identifier for the patient. Example { "path": "/identifier/-", "op": "add", "value": { "type": { "coding": [ { "code": "MR", "system": "http://hl7.org/fhir/v2/0203" } ] }, "system": "urn:oid:1.1.1.1.1.1", "value": "<unique identifier>", "period": { "start": "2016-01-02T00:00:00-05:00", "end": "2020-01-02T00:00:00-05:00" } } } Notes Must not contain the assigner and use fields. Must contain the type, system and value fields, and must include a time component with a timezone when specifying a period. top of section
/identifier/{index}/id	test	string
Description Test the value of the Identifier.id of the identifier at the given {index} in the list of patient identifiers. Example { "path": "/identifier/1/id", "op": "test", "value": "CI-9926250-1" } top of section
/identifier/{index}	remove	N/A
Description Remove the identifier at the given {index} in the list of patient identifiers. Example { "path": "/identifier/1", "op": "remove" } Notes Requires a test operation to be provided for the Identifier.id of the identifier intended to be removed. top of section
/identifier/{index}/system	replace	uri
Description Replace the Identifier.system of the identifier at the given {index} in the list of patient identifiers. Example { "path": "/identifier/1/system", "op": "replace", "value": "urn:oid:2.16.840.1.113883.3.13.6" } Notes Requires a test operation to be provided for the Identifier.id of the identifier whose system is intended to be replaced. top of section
/identifier/{index}/value	replace	string
Description Replace the Identifier.value of the identifier at the given {index} in the list of patient identifiers. Example { "path": "/identifier/1/value", "op": "replace", "value": "<unique identifier>" } Notes Requires a test operation to be provided for the Identifier.id of the identifier whose value is intended to be replaced. top of section
/identifier/{index}/period	replace	Period
Description Replace the Identifier.period of the identifier at the given {index} in the list of patient identifiers. Example { "path": "/identifier/1/period", "op": "replace", "value": { "start": "2016-01-02T00:00:00-05:00", "end": "2022-01-02T00:00:00-05:00" } } Notes Requires a test operation to be provided for the Identifier.id of the identifier whose period is intended to be replaced. The start and end when provided must include a time component with a timezone. When either start or end are not provided its value will be unset. top of section
/name/{index}/id	test	string
Description Test the value of the HumanName.id of the name at the given {index} in the list of patient names. Example { "path": "/name/0/id", "op": "test", "value": "CI-5786010-0" } Notes This operation is only supported for the first name in the list of patient names ({index} == 0). top of section
/name/{index}/family	replace	String
Description Replace the HumanName.family of the name at the given {index} in the list of patient names. Example { "path": "/name/0/family", "op": "replace", "value": "Potter" } Notes Requires a test operation to be provided for the HumanName.id of the name whose family is intended to be replaced. This operation is only supported for the first name in the list of patient names ({index} == 0). top of section
/name/{index}/given	replace	String
Description Replace the HumanName.given of the name at the given {index} in the list of patient names. Example { "path": "/name/0/given", "op": "replace", "value": [ "Harry", "James" ] } Notes Requires a test operation to be provided for the HumanName.id of the name whose given is intended to be replaced. This operation is only supported for the first name in the list of patient names ({index} == 0). If fewer values for given are provided in the list than previously set, the additional older values will be unset. top of section
/name/{index}/prefix	replace	String
Description Replace the HumanName.prefix of the name at the given {index} in the list of patient names. Example { "path": "/name/0/prefix", "op": "replace", "value": "Mr." } Notes Requires a test operation to be provided for the HumanName.id of the name whose prefix is intended to be replaced. This operation is only supported for the first name in the list of patient names ({index} == 0). If no prefix value is provided the prefix on the name will be unset. top of section
/name/{index}/suffix	replace	String
Description Replace the HumanName.suffix of the name at the given {index} in the list of patient names. Example { "path": "/name/0/suffix", "op": "replace", "value": "Jr." } Notes Requires a test operation to be provided for the HumanName.id of the name whose suffix is intended to be replaced. This operation is only supported for the first name in the list of patient names ({index} == 0). If no suffix value is provided the suffix on the name will be unset. top of section
/name/{index}/period	replace	Period
Description Replace the HumanName.period of the name at the given {index} in the list of patient names. Example { "path": "/name/0/period", "op": "replace", "value": { "start": "2016-01-02T00:00:00-05:00" } } Notes Requires a test operation to be provided for the HumanName.id of the name whose period is intended to be replaced. This operation is only supported for the first name in the list of patient names ({index} == 0). Must not contain the end field. The start must include a time component with a timezone. top of section
/telecom/-	add	ContactPoint
Description Add a new contact detail for the patient. Example { "path": "/telecom/-", "op": "add", "value": { "system": "phone", "value": "8168229121", "use": "home", "extension": [ { "valueString": "12345", "url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension" } ], "period": { "start": "2012-05-17T15:33:18.000Z" } } } Notes Must contain the system, use and value fields, and must include a time component with a timezone when specifying a period. top of section
/telecom/{index}/id	test	string
Description Test the value of the ContactPoint.id of the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/0/id", "op": "test", "value": "CI-PH-2807950-0" } top of section
/telecom/{index}	remove	N/A
Description Remove the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/1", "op": "remove" } Notes Requires a test operation to be provided for the ContactPoint.id of the telecom intended to be removed. top of section
/telecom/{index}/value	replace	string
Description Replace the ContactPoint.value of the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/1/value", "op": "replace", "value": "987-654-3210" } Notes Requires a test operation to be provided for the ContactPoint.id of the telecom whose value is intended to be replaced. top of section
/telecom/{index}/rank	replace	positiveInt
Description Replace the ContactPoint.rank of the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/1/rank", "op": "replace", "value": 2 } Notes Requires a test operation to be provided for the ContactPoint.id of the telecom whose rank is intended to be replaced. top of section
/telecom/{index}/extension	replace	Extension
Description Replaces the phone extension of the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/1/extension", "op": "replace", "value": [ { "valueString": "12345", "url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension" } ] } Notes Requires a test operation to be provided for the ContactPoint.id of the telecom whose extension value is intended to be replaced. The system field of the telecom whose extension is intended to be replaced must be 'phone'. If no valueString is provided, the phone extension will be unset. The url must be 'http://hl7.org/fhir/StructureDefinition/contactpoint-extension'. top of section
/telecom/{index}/period	replace	Period
Description Replace the ContactPoint.period of the telecom at the given {index} in the list of patient telecoms. Example { "path": "/telecom/1/period", "op": "replace", "value": { "start": "2016-01-02T00:00:00-05:00", "end": "2022-01-02T00:00:00-05:00" } } Notes Requires a test operation to be provided for the ContactPoint.id of the telecom whose period is intended to be replaced. The start and end when provided must include a time component with a timezone. When either start or end are not provided its value will be unset. top of section
/gender	replace	code
Description Replace the gender that the patient is considered to have for administration and record keeping purposes. Example { "path": "/gender", "op": "replace", "value": "female" } top of section
/birthDate	replace	date
Description Replace the date of birth for the individual. Example { "path": "/birthDate", "op": "replace", "value": "1990-09-15" } top of section
/address/-	add	Address
Description Add a new address for the patient. Example { "path": "/address/-", "op": "add", "value": { "use": "home", "line": [ "1212 Faircastle Drive", "Apartment 406" ], "city": "KC", "district": "Jackson", "state": "KS", "postalCode": "64199", "country": "United States of America", "period": { "start": "2012-05-17T15:33:18.000Z" } } } Notes Must not contain the text field. Must contain the use field, and must include a time component with a timezone when specifying a period. top of section
/address/{index}/id	test	string
Description Test the value of the Address.id of the address at the given {index} in the list of patient addresses. Example { "path": "/address/0/id", "op": "test", "value": "CI-2671902-0" } top of section
/address/{index}	remove	N/A
Description Remove the address at the given {index} in the list of patient addresses. Example { "path": "/address/1", "op": "remove" } Notes Requires a test operation to be provided for the Address.id of the address intended to be removed. top of section
/address/{index}/line	replace	string
Description Replace the Address.line of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/line", "op": "replace", "value": [ "1212 Faircastle Drive", "Apartment 410" ] } Notes Requires a test operation to be provided for the Address.id of the address whose line is intended to be replaced. If no line is provided, all the lines on the address will be unset. If fewer values for line are provided in the list than previously set, the additional older values will be unset. top of section
/address/{index}/city	replace	string
Description Replace the Address.city of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/city", "op": "replace", "value": "St. Louis" } Notes Requires a test operation to be provided for the Address.id of the address whose city is intended to be replaced. If no city is provided, the city on the address will be unset. top of section
/address/{index}/district	replace	string
Description Replace the Address.district of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/district", "op": "replace", "value": "Johnson" } Notes Requires a test operation to be provided for the Address.id of the address whose district is intended to be replaced. If no district is provided, the district on the address will be unset. top of section
/address/{index}/state	replace	string
Description Replace the Address.state of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/state", "op": "replace", "value": "MO" } Notes Requires a test operation to be provided for the Address.id of the address whose state is intended to be replaced. If no state is provided, the state on the address will be unset. top of section
/address/{index}/postalCode	replace	string
Description Replace the Address.postalCode of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/postalCode", "op": "replace", "value": "66209" } Notes Requires a test operation to be provided for the Address.id of the address whose postalCode is intended to be replaced. If no postalCode is provided, the postalCode on the address will be unset. top of section
/address/{index}/country	replace	string
Description Replace the Address.country of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/country", "op": "replace", "value": "Canada" } Notes Requires a test operation to be provided for the Address.id of the address whose country is intended to be replaced. If no country is provided, the country on the address will be unset. top of section
/address/{index}/period	replace	Period
Description Replace the Address.period of the address at the given {index} in the list of patient addresses. Example { "path": "/address/1/period", "op": "replace", "value": { "start": "2016-01-02T00:00:00-05:00", "end": "2022-01-02T00:00:00-05:00" } } Notes Requires a test operation to be provided for the Address.id of the address whose period is intended to be replaced. The start and end when provided must include a time component with a timezone. When either start or end are not provided its value will be unset. top of section
/maritalStatus	replace	CodeableConcept
Description Replace the patient's most recent marital (civil) status. Example { "path": "/maritalStatus", "op": "replace", "value": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "S" } ] } } top of section
/communication	replace	BackboneElement
Description Replace the language which may be used to communicate with the patient about his health. Example { "path": "/communication", "op": "replace", "value": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en", } ] }, "preferred": true } ] } Notes Patient.communication value should a list with only a single element. top of section
/generalPractitioner/-	add	Reference
Description Add a new nominated care provider. Example { "path": "/generalPractitioner/-", "op": "add", "value": { "reference": "Practitioner/995932" } } Notes Must be a reference to a Practitioner. top of section
/generalPractitioner/{index}/id	test	string
Description Test the value of the Reference.id of the general practitioner at the given {index} in the list of the patient's nominated care providers. Example { "path": "/generalPractitioner/1/id", "op": "test", "value": "CI-312732-2" } top of section
/generalPractitioner/{index}	remove	N/A
Description Remove the general practitoner at the given {index} in the list of the patient's nominated care providers. Example { "path": "/generalPractitioner/1", "op": "remove" } Notes Requires a test operation to be provided for the Reference.id of the general practitioner intended to be removed. top of section
/extension	replace	Extension
Description Replace the value of an extension that adds additional information about the patient. Example { "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" } } ] }, { "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" }, { "valueDateTime": "2019-12-26T15:41:52.000Z", "url": "verified-datetime" } ], "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference" } ] } ] } Notes Supported extensions that can be replaced: US Core Birth Sex US Core Race US Core Ethnicity top of section
/extension/{index}/id	test	string
Description Test the value of the CommunicationPreference.id of the Communication Preference at the given {index} in the list of the patient's extensions. Example { "path": "/extension/1/id", "op": "test", "value": "151534123" } top of section
/extension/{index}	remove	N/A
Description Remove the CommunicationPreference at the given {index} in the list of the patient's extensions. Example { "path": "/extension/1", "op": "remove" } Notes Requires a test operation to be provided for the CommunicationPreference.id of the Communication Preference intended to be removed. top of section
/extension/-	add	Communication Preference
Description Add a new Communication Preference extension for the patient. Example { "path": "/extension/-", "op": "add", "value": { "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" }, { "valueDateTime": "2019-12-26T15:41:52.000Z", "url": "verified-datetime" } ], "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference" } ] } } Notes Must be a valid CommunicationPreference extension. top of section
/extension/{index}	replace	Communication Preference
Description Replace the CommunicationPreference at the given {index} in the list of the patient's extensions. At a time only one communication Preference can be changed. Example { "path": "/extension/0", "op": "replace", "value": { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference", "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.cerner.com/dacc6494-e336-45ad-8729-b789ff8663c6/codeSet/4640016", "code": "2572145011", "display": "Clinical Communications", "userSelected": true } ] }, "url": "communication-type" }, { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.cerner.com/34fc7274-1120-4899-937d-a9ea1becc848/codeSet/23042", "code": "4054468" } ] }, "url": "contact-method" } ] } } Notes Requires a test operation to be provided for the CommunicationPreference.id of the Communication Preference intended to be removed. Test operation path and replace extension path index should be same. top of section

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: 81c05ba01b2c19e5bf421449ff8e97eb

The ETag response header indicates the current If-Match version to use on subsequent updates.

Errors

The common errors and OperationOutcomes may be returned.

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.