Person

Overview

The Person resource identifies an individual outside of a specific health care context providing a mechanism to link person resources across different facilities or organizations.

The following fields are returned if valued:

Terminology Bindings

Person.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

Search for Persons that meet supplied query parameters:

GET /Person?:parameters

Authorization Types

Parameters

Name Required? Type Description
_id No, if populated all other parameters are ignored token The logical resource id associated with the resource.
identifier Yes, or _id token The person identifier. Example: urn:oid:2.16.840.1.113883.3.13.6|01022228

Notes:

Headers

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

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Person?identifier=urn%3Aoid%3A2.16.840.1.113883.3.13.6%7Curn%3Acerner%3Aidentity-federation%3Arealm%3A687f29dd-69dd-4de5-acb1-fd8a2241ef3a%3Aprincipal%3AEC4Ax54P8GI

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "7e526ecc-99ef-4c34-bbaa-f17f732b36e9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Person?identifier=urn%3Aoid%3A2.16.840.1.113883.3.13.6%7Curn%3Acerner%3Aidentity-federation%3Arealm%3A687f29dd-69dd-4de5-acb1-fd8a2241ef3a%3Aprincipal%3AEC4Ax54P8GI"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Person/1316024",
      "resource": {
        "resourceType": "Person",
        "id": "1316024",
        "meta": {
          "versionId": "32",
          "lastUpdated": "2017-01-12T17:51:03.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Person</b></p><p><b>Name</b>: Williams, Rory</p><p><b>DOB</b>: 1961-04-30</p><p><b>Sex</b>: Male</p><p><b>Status</b>: Active</p></div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/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:687F29DD-69DD-4DE5-ACB1-FD8A2241EF3A:PRINCIPAL:EC4AX54P8GI",
            "period": {
              "start": "2016-11-01T10:00:00.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/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:687f29dd-69dd-4de5-acb1-fd8a2241ef3a:principal:EC4Ax54P8GI",
            "period": {
              "start": "2016-11-01T10:00:00.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/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": "NEW-FEDPRINCIPAL-ALIAS-12212016",
            "period": {
              "start": "2016-01-02T05:00:00.000Z",
              "end": "2017-01-02T05:00:00.000Z"
            }
          }
        ],
        "name": [
          {
            "use": "official",
            "text": "Williams, Rory",
            "family": [
              "Williams"
            ],
            "given": [
              "Rory"
            ],
            "period": {
              "start": "2012-05-17T14:54:31.000Z"
            }
          },
          {
            "given": [
              "Rory"
            ],
            "period": {
              "start": "2012-05-22T15:45:50.000Z"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "1231231231",
            "use": "work",
            "period": {
              "start": "2013-03-11T07:17:03.000Z"
            }
          },
          {
            "system": "phone",
            "value": "8168229121",
            "use": "home",
            "period": {
              "start": "2012-05-17T15:33:18.000Z"
            }
          },
          {
            "system": "phone",
            "value": "8162324455",
            "use": "mobile",
            "period": {
              "start": "2013-01-30T14:56:59.000Z"
            }
          }
        ],
        "gender": "male",
        "birthDate": "1961-04-30",
        "address": [
          {
            "use": "home",
            "text": "101 Someplace Cool\nKansas City, MO 64199\nUSA",
            "line": [
              "101 Someplace Cool"
            ],
            "city": "Kansas City",
            "district": "Jackson",
            "state": "MO",
            "postalCode": "64199",
            "country": "USA",
            "period": {
              "start": "2012-05-17T15:33:18.000Z"
            }
          }
        ],
        "active": true
      }
    }
  ]
}

Errors

The common errors may be returned.

Retrieve by id

List an individual Person by its id:

GET /Person/:id

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/Person/4342009

Response

Status: 200 OK
{
  "resourceType": "Person",
  "id": "4342009",
  "meta": {
    "versionId": "3",
    "lastUpdated": "2016-11-11T18:10:13.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Person</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>Status</b>: Active</p></div>"
  },
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/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:687f29dd-69dd-4de5-acb1-fd8a2241ef3a:principal:YP2qT7jS2sa",
      "period": {
        "start": "2016-11-01T10:00:00.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/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:687F29DD-69DD-4DE5-ACB1-FD8A2241EF3A:PRINCIPAL:YP2QT7JS2SA",
      "period": {
        "start": "2016-11-01T10:00:00.000Z"
      }
    }
  ],
  "name": [
    {
      "use": "official",
      "text": "Smart, Nancy",
      "family": [
        "Smart"
      ],
      "given": [
        "Nancy"
      ],
      "period": {
        "start": "2016-06-22T20:43:05.000Z"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1980-08-11",
  "active": true
}

Errors

The common errors may be returned.

Person Combines Example

Cerner Millennium supports the ability to logically merge a person record into another person record when both records are describing the same person. This is known as a “person combine”. If necessary, this merging can later be undone by performing a “person uncombine”. When the requested person record has been combined into another record, an inactive Person entry will be returned which has a link to the current Person 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 person 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/Person/4860007

Response

Status: 200 OK
{
  "resourceType": "Person",
  "id": "4860007",
  "active": false,
  "link": [
    {
      "target": {
        "reference": "Person/4342008"
      }
    }
  ]
}

Errors

The common errors may be returned.