Patient

• Overview
• Terminology Bindings
• Extensions
• Search
  • Parameters
  • Headers
  • Example
  • Errors and Informational messages

Overview

For the Patient resource query, the API returns a set of data stored for the patient as a result of Soarian admission, discharge, transfer (ADT) conversations. The response represents the most current information about the patient charted in Soarian at the time of query.

The following fields are returned if valued:

• Identifier
• Patient name
• Gender see Implementation notes
• Date of Birth
• Address
• Language
• One or more patient races and ethnicities will be returned as extensions, see Extensions

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

Extensions

The bundle extension can be returned, see possible codes in the errors section below.

The following extensions can also be returned:

• US Core Race
• US Core Ethnicity

Search

GET /Patient?:parameters

Implementation Notes

• The API returns the most current patient list.
• Returns the administrative gender only. Birth sex, if charted and configured, is returned from the Observation resource.

Parameters

Name	Required?	Type	Description
patientId	Y	reference	The patient identifier provided in a pre-requisite authorization step.

Headers

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

Example

Request

GET https://fhir-myrecord.sandboxcerner.com/dstu2/123abc/Patient?patientId=393EC770-CFC9-4F5A-8B3A-784F2508F245

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "9c745c40-93f8-4cfe-9540-78c2a3a44902",
  "meta": {
    "lastUpdated": "2017-03-01T11:17:27.125-05:00"
  },
  "extension": [
    {
      "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
      "valueExtension": {
        "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
        "extension": [
          {
            "url": "Severity",
            "valueString": "info"
          },
          {
            "url": "Code",
            "valueString": "papi003"
          },
          {
            "url": "Message",
            "valueString": "This is the most current, known Patient data and may not reflect the state of information known at a previous date."
          }
        ]
      }
    }
  ],
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "base-url/bf615549-44cc-4899-bfa9-2cfd86bf358c/Patient?patientId=393EC770-CFC9-4F5A-8B3A-784F2508F245&_format=json"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        "id": "393EC770-CFC9-4F5A-8B3A-784F2508F245",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/us-core-birth-sex",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/administrative-gender",
                  "code": "M",
                  "display": "Male"
                }
              ],
              "text": "Male"
            }
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div><b>Name</b>: testy test<br/><b>Date of Birth</b>: 1992-08-09<br/><b>Sex</b>: Male<br/></div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/v2/0203",
                  "code": "MR"
                }
              ]
            },
            "value": "Downtown (Usability) - 2342344"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "usual",
            "text": "testy,test null null",
            "family": [
              "testy"
            ],
            "given": [
              "test"
            ]
          }
        ],
        "gender": "male",
        "birthDate": "1992-08-09",
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/v3/NullFlavor",
              "code": "UNK"
            }
          ]
        }
      }
    }
  ]
}

Errors and Informational messages

The common errors and informational messages can be returned.

These additional informational messages may be returned within the bundle extension:

Code	Message
papi003	This is the most current, known Patient data and may not reflect the state of information known at a previous date.
papi004	No patient information is available.