FHIR R4 APIs for Oracle Soarian Clinicals

Get a patient by ID

get

/Patient/{ID}

List an individual Patient by its ID.

GET /Patient/:id

This operation supports the following authorization types:

Provider
Patient

Request

Path Parameters

ID(required): string

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

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/A879904FD2FE4B2D90C89FDA84E1285F

Example Response:

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

Linking Duplicate Patient Records Example

The link element is used to assert that patient resources refer to the same patient. This element is used to support the scenario where a duplicate record is retired; this process is known as a patient merge in Soarian Clincials????. When the requested patient record has been merged into another record, an inactive Patient entry is returned that has a link to the current Patient entry. Entries for merged, or source, patients are only returned when retrieving the entries directly by ID. Entries for the target patient are returned with all qualifying searches. The ability to perform patient merge operations is not available through the Cerner Ignite APIs for Soarian Clinicals???? platform.
Example Request

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

Example Response:

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

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.