Patient

Overview

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

The following fields are returned if valued:

Terminology Bindings

Patient.identifier.type
Patient.contact.relationship

Extensions

Search for Patients that meet supplied query parameters:

GET /Patient?:parameters

Implementation Notes

Authorization Types

Parameters

Name Required? Type Description
_id This, or any other required search parameter token The logical resource id associated with the resource.
identifier This and/or any other search param, or _id token A patient identifier. Example: urn:oid:1.1.1.1.1.1|1022228
name This and/or any other search param, or _id string The start of either family or given name of the patient. Example: Pete
family This and/or any other search param, or _id string The start of the family name of the patient. Example: Adam
given This and/or any other search param, or _id string The start of the given name of the patient. Example: Tim
birthdate This and/or any other search param, or _id date The patient’s date of birth. Example: 1961-01-16
phone This and/or any other search param, or _id token The patient’s phone number. Example: 1111111111
email This and/or any other search param, or _id token The patient’s email address. Example: example@example.com
address-postalcode This and/or any other search param, or _id string The postal code in the address details of the patient. Example: 11111
gender No string The 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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Patient?_id=4342009

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "567efe76-2573-46be-85dc-8ea698dfa9d0",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Patient?_id=4342009&_count=20"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Patient/4342009",
      "resource": {
        "resourceType": "Patient",
        "id": "4342009",
        "meta": {
          "versionId": "2",
          "lastUpdated": "2016-06-22T20:51:35.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Patient</b></p><p><b>Name</b>: Smart, Nancy</p><p><b>DOB</b>: 1980-08-11</p><p><b>Sex</b>: Female</p><p><b>Marital Status</b>: Married</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
            "valueDateTime": "1980-08-11T12:33:00.000-05:00"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          },
          {
            "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": "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": "text",
                "valueString": "Not Hispanic or Latino"
              }
            ]
          }
        ],
        "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:1.1.1.1.1.1",
            "value": "10002701",
            "period": {
              "start": "2016-06-22T20:43:05.000Z"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "text": "Smart, Nancy",
            "family": [
              "Smart"
            ],
            "given": [
              "Nancy"
            ],
            "period": {
              "start": "2016-06-22T20:43:05.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "1980-08-11",
        "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/1912007",
            "display": "Forrest, Fhir"
          }
        ]
      }
    }
  ]
}

Errors

The common errors may be returned.

Retrieve by id

List an individual Patient by its id:

GET /Patient/:id

Implementation Notes

Authorization Types

Headers

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

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Patient/4342008

Response

Status: 200 OK
{
  "resourceType": "Patient",
  "id": "4342008",
  "meta": {
    "versionId": "2",
    "lastUpdated": "2016-06-22T20:27:38.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Patient</b></p><p><b>Name</b>: Smart, Wilma</p><p><b>DOB</b>: 1947-03-16</p><p><b>Sex</b>: Female</p><p><b>Status</b>: Active</p></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
      "valueDateTime": "1947-03-16T13:36:00.000-06:00"
    },
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
      "valueCode": "F"
    },
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-race",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Race",
            "code": "2054-5",
            "display": "Black or African American",
            "userSelected": false
          }
        },
        {
          "url": "text",
          "valueString": "Black or African American"
        }
      ]
    },
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Ethnicity",
            "code": "2135-2",
            "display": "Hispanic or Latino",
            "userSelected": false
          }
        },
        {
          "url": "text",
          "valueString": "Hispanic or Latino"
        }
      ]
    }
  ],
  "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:1.1.1.1.1.1",
      "value": "10002700",
      "period": {
        "start": "2016-06-22T20:25:56.000Z"
      }
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "text": "Smart, Wilma",
      "family": [
        "Smart"
      ],
      "given": [
        "Wilma"
      ],
      "period": {
        "start": "2016-06-22T20:25:58.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1947-03-16",
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English",
            "userSelected": false
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "careProvider": [
    {
      "reference": "Practitioner/1912007",
      "display": "Forrest, Fhir"
    }
  ]
}

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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Patient/4860007

Response

Status: 200 OK
{
  "resourceType": "Patient",
  "id": "4860007",
  "meta": {
    "versionId": "0"
  },
  "active": false,
  "link": [
    {
      "other": {
        "reference": "Patient/4342008"
      },
      "type": "replace"
    }
  ]
}

Errors

The common errors may be returned.