Person

Overview

The Person resource identifies an individual outside of a specific healthcare context and provides a mechanism to associate person resources across different facilities or organizations.

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

Person.identifier.type

Search for persons that meet supplied query parameters.

GET /Person?:parameters

Authorization Types

Parameters

Name Required Type Description
_id Conditionally token The logical resource ID associated with the resource. This parameter is required if the identifier parameter is not used.
identifier Conditionally token The person identifier. This parameter is required if the _id parameter is not used.

Notes:

Headers

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

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?identifier=urn:oid:2.16.840.1.113883.6.1000|31577

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "f2800374-292d-4508-bd3f-b4da814d1b5f",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?identifier=urn%3Aoid%3A2.16.840.1.113883.6.1000%7C6931"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person/12724067",
      "resource": {
        "resourceType": "Person",
        "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>Person</b></p><p><b>Status</b>: Active</p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p></div>"
        },
        "identifier": [
          {
            "id": "CI-490525912-3",
            "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": "31577"
          }
        ],
        "name": [
          {
            "id": "CI-12724067-0",
            "use": "official",
            "text": "SMART, JOE",
            "family": "SMART",
            "given": [
              "JOE"
            ],
            "period": {
              "start": "2019-12-26T15:14:12.000Z"
            }
          }
        ],
        "telecom": [
          {
            "id": "CI-PH-29811920-0",
            "extension": [
              {
                "valueUrl": "(816)888-8886",
                "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
              }
            ],
            "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@example.com",
            "use": "home",
            "rank": "1",
            "period": {
              "start": "2020-03-30T19:31:11.000Z"
            }
          }
        ],
        "gender": "male",
        "birthDate": "1976-04-29",
        "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"
            }
          }
        ],
        "active": true
      }
    }
  ]
}

Retrieve by ID

List an individual person by their ID.

GET /Person/:id

Authorization Types

Headers

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

Example

Request

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

Response

Status: 200 OK
{
  "resourceType": "Person",
  "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>Person</b></p><p><b>Status</b>: Active</p><p><b>Name</b>: SMART, JOE</p><p><b>DOB</b>: Apr 29, 1976</p><p><b>Administrative Gender</b>: Male</p></div>"
  },
  "identifier": [
    {
      "id": "CI-490525912-3",
      "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": "31577"
    }
  ],
  "name": [
    {
      "id": "CI-12724067-0",
      "use": "official",
      "text": "SMART, JOE",
      "family": "SMART",
      "given": [
        "JOE"
      ],
      "period": {
        "start": "2019-12-26T15:14:12.000Z"
      }
    }
  ],
  "telecom": [
    {
      "id": "CI-PH-29811920-0",
      "extension": [
        {
          "valueUrl": "(816)888-8886",
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
        }
      ],
      "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@example.com",
      "use": "home",
      "rank": "1",
      "period": {
        "start": "2020-03-30T19:31:11.000Z"
      }
    }
  ],
  "gender": "male",
  "birthDate": "1976-04-29",
  "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"
      }
    }
  ],
  "active": true
}

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.

Person Combines Example

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

Request

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

Response

Status: 200 OK
{
  "resourceType": "Person",
  "id": "12742633",
  "meta": {
    "versionId": "0"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Person</b></p><p><b>Status</b>: Inactive</p><p><b>Link</b>: Person/12724067</p></div>"
  },
  "active": false,
  "link": [
    {
      "target": {
        "reference": "Person/12724067"
      }
    }
  ]
}