FHIR R4 APIs for Oracle Soarian Clinicals

Get a list of patients

get

/Patient

Search for patients that meet specified query parameters.

GET /Patient?:parameters

This operation supports the following authorization types:

Provider
Patient
System

Notes

A 422 (unprocessable entity) HTTP response status code and OperationOutcome are returned when more than 499 patients qualify for the search criteria. FHIR applications may prompt the user for more specific search criteria to avoid this possibility.
See the following items for a Patient user:

A search without any parameter is supported, which returns all the Patient resources that the user can access. This is applicable only for an authorization_type of patient.
All other search parameters are supported as either the _id or a combination of identifier, birthdate, name, family, or given. These parameters must be provided while still returning only the Patient resources that the user can access.

For the Provider user, either the _id or a combination of identifier, birthdate, name, family, or given parameters must be provided.

Error
In addition, a 422 Unprocessable Entity HTTP response status code and OperationOutcome is returned when more than 499 patients qualify for the search criteria.

Request

Query Parameters

_id: string

The logical resource ID associated with the resource.
Type: token.
_revinclude: string

A request to include any Provenance resource in the bundle that refers to a Patient resource in the search results. Only supported with Provenance. Type: _revinclude.
The _revinclude parameter may be provided once with the value Provenance:target. For example, _revinclude=Provenance:target.
When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.
birthdate: string

The patient's date of birth. For example, 1990-01-01.
Type: date.
The birthdate parameter may be provided once using the eq prefix.
It may be provided up to twice to imply a date range using one of the following prefixes: ge, le, gt, or lt.
It must not be provided with a time component.
family: string

The start of the patient's family name. Previous name values are not searchable. For example, Doe.
Type: string.
This parameter may be provided exactly once and may have only a single value.
This parameter searches for current and previous names.
This parameter allows searching for normalized values including when these values may contain accented characters. For example, Schl????ter will match Schl????ter and Schlueter, but not Schluter.
gender: string

The patient's gender. For example, male.
Type:token.
The gender parameter may only be provided if at least one of the identifier, birthdate, name, family, or given parameters is provided.
This parameter may be provided exactly once and may have only a single value.
given: string

The start of the patient's given name. Previous name values are not searchable. For example, Jane.
Type: string.
This parameter may be provided exactly once and may have only a single value.
This parameter searches for current and previous names.
This parameter allows searching for normalized values including when these values may contain accented characters. For example, Schl????ter will match Schl????ter and Schlueter, but not Schluter.
identifier: string

A patient identifier. Only MR, PI, or SB identifiers are supported and, therefore, searched. For example, urn:oid:1.1.1.1.1.1|1022228.
Type: token.
The identifier parameter supports the :of-type modifier and has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code and match if any of the type codes match. All three parts of the format must be present.
This parameter may be provided exactly once and may have only a single value.
name: string

The start of either the family or the given name of the patient. Previous name values are not searchable. For example, Doe.
Type: string.
This parameter may be provided exactly once and may have only a single value.
This parameter searches for current and previous names.
This parameter allows searching for normalized values including when these values may contain accented characters. For example, Schl????ter will match Schl????ter and Schlueter, but not Schluter.

Header Parameters

Accept(required): string

The media type to be requested. Refer to 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/fhir+json

Default Response

Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Patient?_id=A879904FD2FE4B2D90C89FDA84E1285F

Example Response

{
    "resourceType": "Bundle",
    "id": "2fa0b1dc-ecab-4744-bb53-d4a21f3e7b73",
    "type": "searchset",
    "timestamp": "2021-02-15T15:09:40-05:00",
    "entry": [
      {
        "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Patient/A879904FD2FE4B2D90C89FDA84E1285F",
        "resource": {
          "resourceType": "Patient",
          "id": "A879904FD2FE4B2D90C89FDA84E1285F",
          "meta": {
            "lastUpdated": "2021-01-21T15:08:01-05:00"
          },
          "gender": "female",
          "birthDate": "2010-03-11",
          "communication": [
            {
              "language": {
                "coding": [
                  {
                    "system": "urn:ietf:bcp:47",
                    "code": "EN"
                  }
                ],
                "text": "English"
              }
            }
          ],
          "active": true,
          "name": [
            {
              "use": "usual",
              "text": "Mcgovern,Astrid Santiago",
              "family": "Mcgovern",
              "given": [
                "Astrid",
                "Santiago"
              ],
              "suffix": [
                "Mrs."
              ]
            }
          ],
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "SB",
                    "display": "Social Beneficiary Identifier"
                  }
                ],
                "text": "SSN"
              },
              "system": "http://hl7.org/fhir/sid/us-ssn",
              "value": "598-00-4749"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MR",
                    "display": "Medical record number"
                  }
                ],
                "text": "MR"
              },
              "system": "urn:oid:2.1.5.234.99.1.3.7.1",
              "value": "INF103"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "PI",
                    "display": "Patient internal identifier"
                  }
                ],
                "text": "MPI"
              },
              "system": "urn:oid:2.1.5.234.99.1.3.7.2",
              "value": "INF1003"
            }
          ],
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
              "valueCode": "F"
            },
            {
              "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
              "extension": [
                {
                  "url": "ombCategory",
                  "valueCoding": {
                    "system": "urn:oid:2.16.840.1.113883.6.238",
                    "code": "2106-3",
                    "display": "White"
                  }
                },
                {
                  "url": "text",
                  "valueString": "White"
                }
              ]
            },
            {
              "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
              "extension": [
                {
                  "url": "ombCategory",
                  "valueCoding": {
                    "system": "urn:oid:2.16.840.1.113883.6.238",
                    "code": "2135-2",
                    "display": "Hispanic or Latino"
                  }
                },
                {
                  "url": "text",
                  "valueString": "Hispanic or Latino"
                }
              ]
            }
          ],
          "address": [
            {
              "use": "home",
              "text": "PO Box 549,Des Moines ,IA,50301-0549",
              "line": [
                "PO Box 549"
              ],
              "city": "Des Moines ",
              "state": "IA",
              "postalCode": "50301-0549",
              "period": {
                "start": "2020-04-15T00:00:00-04:00"
              }
            }
          ],
          "telecom": [
            {
              "system": "phone",
              "value": "(818)999-555-4444",
              "use": "home",
              "period": {
                "start": "2020-04-15T00:00:00-04:00"
              }
            }
          ],
          "text": {
            "status": "generated",
            "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Patient</b><br /><b>Status</b>:Active;<b>Name</b>:Mcgovern,Astrid Santiago;<b>DOB</b>:2010-03-11;<b>Administrative Gender</b>:female;</div>"
          }
        }
      }
    ],
    "link": [
      {
        "relation": "self",
        "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Patient?_id=A879904FD2FE4B2D90C89FDA84E1285F"
      }
    ]
  }