Patient

Overview

The Patient resource provides general demographic information about a person receiving healthcare services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone, primary language, and marital status. Millennium is a patient-centric application; thus, many other resources include the patient ID in their queries. A person receiving care from multiple organizations may have information available in multiple patient resources in multiple FHIR servers.

The following fields are returned if valued:

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
  • 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://hl7.org/fhir/v2/0203

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-contact-relationship

Extensions

Search for patients who meet supplied query parameters.

GET /Patient?:parameters

Notes

Authorization Types

Parameters

Name Required? Type Description
_id Conditionally token The logical resource ID associated with the resource. This parameter is required if at least one of the following parameters is not used: identifier, name, family, given, birthdate, phone, email, or address-postalcode. Example: 11111111
identifier Conditionally token A patient identifier. This parameter is required if _id, name, family, given, birthdate, phone, email, and address-postalcode are not used. Example: urn:oid:1.1.1.1.1.1\|1022228
name Conditionally string The start of the family or given name of the patient. This parameter is required if _id, identifier, family, given, birthdate, phone, email, and address-postalcode are not used. Example: Pete
family Conditionally string The start of the family name of the patient. This parameter is required if _id, identifier, name, given, birthdate, phone, email, and address-postalcode are not used. Example: Adam
given Conditionally string The start of the given name of the patient. This parameter is required if _id, identifier, name, family, birthdate, phone, email, and address-postalcode are not used. Example: Tim
birthdate Conditionally date The patient’s date of birth. This parameter is required if _id, identifier, name, family, given, phone, email, and address-postalcode are not used. Example: 1961-01-16
phone Conditionally token The patient’s phone number. This parameter is required if _id, identifier, name, family, given, birthdate, email, and address-postalcode are not used. Example: 1111111111
email Conditionally token The patient’s email address. This parameter is required if _id, identifier, name, family, given, birthdate, phone, and address-postalcode are not used. Example: example@example.com
address-postalcode Conditionally string The postal code in the address details of the patient. This parameter is required if _id, identifier, name, family, given, birthdate, phone, and email are not used. Example: 11111
gender No token The administrative gender of the patient. Example: male
_count No number The maximum number of results to return. Defaults to 20.

Notes

Headers

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

Example

Request

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

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "917b3535-59c9-4b9d-b5bd-604eccb6aaee",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient?_id=12724067"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12724067",
      "resource": {
        "resourceType": "Patient",
        "id": "12724067",
        "meta": {
          "versionId": "6",
          "lastUpdated": "2020-03-30T19:43:17.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-race",
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Race",
                  "code": "2106-3",
                  "display": "White",
                  "userSelected": false
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Race",
                  "code": "2106-3",
                  "userSelected": false
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ]
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity",
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2186-5",
                  "display": "Not Hispanic or Latino",
                  "userSelected": false
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2186-5",
                  "userSelected": false
                }
              },
              {
                "url": "text",
                "valueString": "Not Hispanic, Latino, or Spanish Origin"
              }
            ]
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/v2/0203",
                  "code": "MR",
                  "display": "Medical record number",
                  "userSelected": false
                }
              ],
              "text": "MRN"
            },
            "system": "urn:oid:2.16.840.1.113883.6.1000",
            "value": "6931",
            "_value": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
                  "valueString": "00000006931"
                }
              ]
            },
            "period": {
              "start": "2019-12-26T15:14:12.000Z"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "text": "SMART, JOE",
            "family": [
              "SMART"
            ],
            "given": [
              "JOE"
            ],
            "period": {
              "start": "2019-12-26T15:14:12.000Z"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "8168888886",
            "use": "home",
            "period": {
              "start": "2019-12-26T15:14:12.000Z"
            }
          }
        ],
        "gender": "male",
        "birthDate": "1976-04-29",
        "deceasedBoolean": false,
        "address": [
          {
            "use": "home",
            "text": "12345 Main St\\nKansas city, MO 64116\\nUS",
            "line": [
              "12345 Main St"
            ],
            "city": "Kansas city",
            "district": "Jackson",
            "state": "MO",
            "postalCode": "64116",
            "country": "US",
            "period": {
              "start": "2019-12-26T15:13:36.000Z"
            }
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
              "code": "M",
              "display": "Married",
              "userSelected": false
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en",
                  "display": "English",
                  "userSelected": false
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "careProvider": [
          {
            "reference": "Practitioner/4122622",
            "display": "Cerner Test, Physician - Hospitalist Cerner"
          }
        ]
      }
    }
  ]
}

Retrieve by ID

List an individual patient by their ID.

GET /Patient/:id

Notes

Authorization Types

Headers

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

Example

Request

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

Response

Status: 200 OK
{
  "resourceType": "Patient",
  "id": "12724067",
  "meta": {
    "versionId": "6",
    "lastUpdated": "2020-03-30T19:43:17.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Patient</b></p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p><p><b>Status</b>: Active</p></div>"
  },
  "extension": [
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-race",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Race",
            "code": "2106-3",
            "display": "White",
            "userSelected": false
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Race",
            "code": "2106-3",
            "userSelected": false
          }
        },
        {
          "url": "text",
          "valueString": "White"
        }
      ]
    },
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Ethnicity",
            "code": "2186-5",
            "display": "Not Hispanic or Latino",
            "userSelected": false
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Ethnicity",
            "code": "2186-5",
            "userSelected": false
          }
        },
        {
          "url": "text",
          "valueString": "Not Hispanic, Latino, or Spanish Origin"
        }
      ]
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/v2/0203",
            "code": "MR",
            "display": "Medical record number",
            "userSelected": false
          }
        ],
        "text": "MRN"
      },
      "system": "urn:oid:2.16.840.1.113883.6.1000",
      "value": "6931",
      "_value": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
            "valueString": "00000006931"
          }
        ]
      },
      "period": {
        "start": "2019-12-26T15:14:12.000Z"
      }
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "text": "SMART, JOE",
      "family": [
        "SMART"
      ],
      "given": [
        "JOE"
      ],
      "period": {
        "start": "2019-12-26T15:14:12.000Z"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "8168888886",
      "use": "home",
      "period": {
        "start": "2019-12-26T15:14:12.000Z"
      }
    }
  ],
  "gender": "male",
  "birthDate": "1976-04-29",
  "deceasedBoolean": false,
  "address": [
    {
      "use": "home",
      "text": "12345 Main St\\nKansas city, MO 64116\\nUS",
      "line": [
        "12345 Main St"
      ],
      "city": "Kansas city",
      "district": "Jackson",
      "state": "MO",
      "postalCode": "64116",
      "country": "US",
      "period": {
        "start": "2019-12-26T15:13:36.000Z"
      }
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/v3/MaritalStatus",
        "code": "M",
        "display": "Married",
        "userSelected": false
      }
    ],
    "text": "Married"
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English",
            "userSelected": false
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "careProvider": [
    {
      "reference": "Practitioner/4122622",
      "display": "Cerner Test, Physician - Hospitalist Cerner"
    }
  ]
}

Patient Combine Example

Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This action is known as a patient combine. If necessary, a patient uncombine can undo this merging. When the requested patient record is combined into another record, an inactive patient entry is returned with a link to the current patient entry. Entries for combined patients are only returned when retrieving the entries directly by ID. They are not returned when searching with other parameters.

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742633

Response

Status: 200 OK
{
  "resourceType": "Patient",
  "id": "12742633",
  "meta": {
    "versionId": "0"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Patient</b></p><p><b>Replaced By</b>: Patient/12724067</p><p><b>Status</b>: Inactive</p></div>"
  },
  "active": false,
  "_gender": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  },
  "link": [
    {
      "other": {
        "reference": "Patient/12724067"
      },
      "type": "replace"
    }
  ]
}

Create

Create an individual patient.

POST /Patient

Notes

Authorization Types

Headers

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

Body Fields

Notes

Name Required Type
resourceType Yes string
  • Description
    • The type of the FHIR resource.
  • Example
    • {
        "resourceType": "Patient"
      }
      
  • Notes
identifier Yes List of Identifier
  • Description
    • The identifiers for the patient.
  • Example
    • {
        "identifier": [
          {
            "assigner": {
              "reference": "Organization/685844"
            }
          },
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "system": "http://hl7.org/fhir/v2/0203"
                }
              ]
            },
            "system": "urn:oid:1.1.1.1.1.1",
            "value": "THIS:IS:A: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.
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
    • Must have one value that is current and has a use of 'official', without an end date, and both a given and family name are present. Names must include the use field, and must contain either the given or family field. All names cannot contain the text field. Only one family name. If additional family names are required they must be provided as a single string separated by blank spaces. 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.
      • At least one name must be provided. The provided name must meet the following conditions:
        • Must have a use of official.
        • Must include both given and family.
        • If set, period must not have an end date.
      • Subsequent names may be provided but have the following constraints:
        • The name must include the use field.
        • The name must contain either the given or family fields.
        • The 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.
active No boolean
  • Description
    • Whether this patient record is in active use.
  • Example
    • {
        "active": true
      }
      
  • Notes
    • If set, the value must be true
telecom No List of ContactPoint
  • Description
    • A contact detail (e.g., a telephone number or an email address) by which the patient may be contacted.
  • Example
    • {
        "telecom": [
          {
            "system": "phone",
            "value": "8168229121",
            "use": "home",
            "period": {
              "start": "2012-05-17T15:33:18.000Z"
            }
          }
        ]
      }
      
  • Notes
    • All values must contain the system, use, and value fields.
gender No code
  • Description
    • Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
  • Example
    • {
        "gender": "male"
      }
      
birthDate No date
  • Description
    • The date of birth for the individual.
  • Example
    • {
        "birthDate": "1989-09-17"
      }
      
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 and must not contain the text field.
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": "Single"
        },
      }
      
communication No 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.

      All the language codes must use ISO-639-1 alpha 2 code in lower case, e.g. "en" for English.
careProvider No List of Reference
  • Description
    • Patient's nominated care provider.
  • Example
    • {
        "careProvider": [
          {
            "reference": "Practitioner/4594010"
          },
          {
            "reference": "Practitioner/4646007"
          }
        ]
      }
      
  • Notes
    • The careProvider must be a reference to a Practitioner.
Birth Sex Extension No Extension
  • Description
    • The sex of the patient at birth.
  • Example
    • {
        "extension": [
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
      }
      

Example

Request

POST https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient

Body

{
  "resourceType": "Patient",
  "identifier": [
    {
      "assigner": {
        "reference": "Organization/685844"
      }
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": [
        "Wolf"
      ],
      "given": [
        "Person",
        "Name"
      ],
      "period": {
        "start": "2010-05-17T14:54:31.000Z"
      }
    },
    {
      "use": "usual",
      "given": [
        "Bigby"
      ],
      "period": {
        "start": "2012-05-22T15:45:50.000Z"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "8168229121",
      "use": "home",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    }
  ],
  "gender": "male",
  "birthDate": "1990-09-15",
  "address": [
    {
      "use": "home",
      "line": [
        "121212 Metcalf Drive",
        "Apartment 403"
      ],
      "city": "Kansas City",
      "district": "Jackson",
      "state": "KS",
      "postalCode": "64199",
      "country": "United States of America",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/v3/MaritalStatus",
        "code": "S",
        "display": "Never Married"
      }
    ],
    "text": "Single"
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English"
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "careProvider": [
    {
      "reference": "Practitioner/4122622"
    }
  ]
}

Response

Status: 201 Created
Date: Tue, 27 Feb 2018 16:47:59 GMT
Cache-Control: no-cache
Vary: Origin,User-Agent,Accept-Encoding
Strict-Transport-Security: max-age=631152000
X-Xss-Protection: 1; mode=block
Pragma: no-cache
X-Request-Id: f17bbd99-f89b-4cfe-8425-43b14e5735cf
opc-request-id: /5E94C5FFC27CDD51DB70C0F464E44A96/AECA8B137DC613A323E70B1ED7C53808
Etag: W/"0"
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
Expires: Mon, 01 Jan 1990 00:00:00 GMT
Last-Modified: Tue, 27 Feb 2018 16:48:00 GMT
Location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/4842008
Content-Length: 0
Content-Type: application/json

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