FHIR DSTU 2 APIs for Oracle Health Millennium Platform

Get a list of patients

get

/Patient

Retrieves a list of patients that meet supplied query parameters.

Note:

The Patient.animal modifier element is not supported and not returned.
Direct secure email is not returned.
If the current user is a patient or patient proxy, a search may be performed without providing any parameters. The search returns all patients that the current user is granted access to view.
Oracle Cerner does not recommend combining family or given parameters with the name parameter when searching for a patient. Whenever possible, use the :exact modifier.
The identifier, name, family, given, phone, email, address-postalcode, or gender parameters may be provided exactly once and may have only a single value.
A 422 (Unprocessable Entity) status code is returned when over 1000 patients qualify for the search criteria.

Request

Query Parameters

_count: integer

Minimum Value: 1

The maximum number of results to return.

Example: _count=15
_id: string

The logical resource ID. This parameter is required if no other parameter is used.

Example: _id=12345
address-postalcode: string

The postal code in the address details of the patient.

The :exact modifier is supported.

Example: address-postalcode=12345
birthdate: string
The patient's date of birth.

The birthdate must not include a time component.

This may be provided
- Once using one of the following prefixes to imply a date range:
  - ge
  - le
  - gt
  - lt
  - eq
- Twice to indicate a date range and must contain one prefix each of le and ge.
Example:
- birthdate=eq2001-03-13
- birthdate=ge2001-03-13&birthdate=le2001-05-01
email: string

The patient's email.

Example: email=example@example.com
family: string

The start of the family name of the patient.

The :exact modifier is supported and searches for current names, based on the name's period.

Example: family=Smith
gender: string

The patient's gender.

Allowed Values: [ "male", "female", "other", "unknown" ]
given: string

The start of the given name of the patient.

The :exact modifier is supported and searches for current names, based on the name's period.

Searching by the given name requires the family parameter.

Example: given=Sally
identifier: string

A patient identifier.

The family or given parameters should not be combined with the name parameter when searching for a patient. The :exact modifier should be used instead.

The value of the identifier parameter must include a code. A Social Security Number (SSN) may be provided, but the value is not returned in a matching response.

Example: identifier=urn:oid:1.1.1.1.1.1|1022228
name: string

The start of the given name or the family name of the patient.

The :exact modifier is supported and searches for current names, based on the name's period.

Example: name=Riley
phone: string

The patient's phone number.

Example: phone=1234567891

Header Parameters

Accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.
Authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.

Response

Supported Media Types

application/json+fhir

Default Response

This operation supports the following authorization types:

Provider
Patient
System

Example Request:

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

Example Response:

{
  "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"
          }
        ]
      }
    }
  ]
}

Headers

X-Request-Id: string

Oracle troubleshooting identifier.
opc-request-id: string

Oracle troubleshooting identifier.