FHIR R4 APIs for Oracle Soarian Clinicals

Get a list of encounters

get

/Encounter

Search for Encounter resources that meet the specified query parameters.

GET /Encounter?:parameters

This operation supports the following authorization types:

Provider
Patient

Notes Encounter.location.location is always returned as a reference to a contained Location resource.

Request

Query Parameters

_id: string

The logical resource ID associated with the resource
This parameter is required if patient is not used.
Type: token.
_revinclude: string

A request to include any Provenance resource in the bundle that refers to an Encounter 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.
date: string

Date range into which the encounter falls. For example: date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z
Type: date.
The date parameter may be provided up to two times and must use the eq, ge, gt, le, or lt prefixes. When a value is provided without a prefix, an implied eq prefix is used. When provided twice, the lower value must have a ge or gt prefix, and the higher value must have an le or lt prefix.
patient: string

The patient who has the encounter.
This parameter is required if _id is not used.
Type: reference.

Header Parameters

Authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
accept(required): string

The media type to be requested. Refer to what the resource's operation produces for what is supported.

Response

Supported Media Types

application/fhir+json

Default Response

Search by Patient
Example Request

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

Example Response:

{
   "resourceType": "Bundle",
   "id": "c6273ad5-a462-4e1c-a7a1-df9f09beccf6",
   "type": "searchset",
   "timestamp": "2022-05-16T03:21:23-04:00",
   "entry": [
     {
       "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
       "resource": {
         "resourceType": "Encounter",
         "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019",
         "meta": {
           "lastUpdated": "2021-01-21T15:08:01-05:00"
         },
         "status": "in-progress",
         "class": {
           "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
           "code": "IMP",
           "display": "inpatient encounter"
         },
         "subject": {
           "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
           "display": "Mcgovern,Astrid Santiago"
         },
         "period": {
           "start": "2020-04-15T16:42:00-04:00"
         },
         "location": [
           {
             "location": {
               "reference": "#35202"
             }
           }
         ],
         "serviceProvider": {
           "reference": "Organization/HCU.1",
           "display": "Health Enterprise"
         },
         "type": [
           {
             "coding": [
               {
                 "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                 "code": "unknown",
                 "display": "Unknown"
               }
             ]
           }
         ],
         "reasonCode": [
           {
             "text": "Pain left side of the body"
           }
         ],
         "participant": [
           {
             "type": [
               {
                 "coding": [
                   {
                     "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                     "code": "ATND",
                     "display": "attender"
                   }
                 ],
                 "text": "Attending Doctor"
               }
             ],
             "period": {
               "start": "2020-11-11T20:53:00-05:00"
             },
             "individual": {
               "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D"
             }
           },
           {
             "type": [
               {
                 "coding": [
                   {
                     "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                     "code": "CON",
                     "display": "consultant"
                   }
                 ],
                 "text": "Consulting Doctor"
               }
             ],
             "period": {
               "start": "2020-11-11T20:53:00-05:00"
             },
             "individual": {
               "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634"
             }
           },
           {
             "type": [
               {
                 "coding": [
                   {
                     "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                     "code": "CON",
                     "display": "consultant"
                   }
                 ],
                 "text": "Consulting Doctor"
               }
             ],
             "period": {
               "start": "2020-11-11T20:53:00-05:00"
             },
             "individual": {
               "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0"
             }
           },
           {
             "type": [
               {
                 "coding": [
                   {
                     "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                     "code": "ADM",
                     "display": "admitter"
                   }
                 ],
                 "text": "Admitting Doctor"
               }
             ],
             "period": {
               "start": "2020-11-11T20:53:00-05:00"
             },
             "individual": {
               "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D"
             }
           }
         ],
         "contained": [
           {
             "resourceType": "Location",
             "name": "Inferno",
             "id": "35202",
             "status": "active",
             "telecom": [
               {
                 "system": "phone",
                 "value": "6102196300"
               },
               {
                 "system": "fax",
                 "value": "6102196300"
               }
             ],
             "address": {
               "use": "work",
               "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States",
               "line": [
                 "53 Valley Stream Parkway"
               ],
               "city": "Malvern",
               "state": "PA",
               "postalCode": "19355",
               "country": "United States"
             },
             "managingOrganization": {
               "reference": "Organization/HCU.1",
               "display": "Health Enterprise"
             }
           }
         ],
         "text": {
           "status": "generated",
           "div": "Encounter
Patient:Mcgovern,Astrid Santiago;
Status:in-progress;
Class:inpatient encounter;
Period Start Date:2020-04-15T16:42:00-04:00;
Service Provider:Health Enterprise;
Type:
System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
Reason for Encounter - Chief Complaint:Pain left side of the body;
Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
"
         }
       }
     }
   ],
   "link": [
     {
       "relation": "self",
       "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F"
     }
   ]
 }

x-_id Response

Search by ID
Example Request

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

Example Response:

{
  "resourceType": "Bundle",
  "id": "c6273ad5-a462-4e1c-a7a1-df9f09beccf6",
  "type": "searchset",
  "timestamp": "2022-05-16T03:21:23-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
      "resource": {
        "resourceType": "Encounter",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.29019",
        "meta": {
          "lastUpdated": "2021-01-21T15:08:01-05:00"
        },
        "status": "in-progress",
        "class": {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "IMP",
          "display": "inpatient encounter"
        },
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "period": {
          "start": "2020-04-15T16:42:00-04:00"
        },
        "location": [
          {
            "location": {
              "reference": "#35202"
            }
          }
        ],
        "serviceProvider": {
          "reference": "Organization/HCU.1",
          "display": "Health Enterprise"
        },
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                "code": "unknown",
                "display": "Unknown"
              }
            ]
          }
        ],
        "reasonCode": [
          {
            "text": "Pain left side of the body"
          }
        ],
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "ATND",
                    "display": "attender"
                  }
                ],
                "text": "Attending Doctor"
              }
            ],
            "period": {
              "start": "2020-11-11T20:53:00-05:00"
            },
            "individual": {
              "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D"
            }
          },
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "CON",
                    "display": "consultant"
                  }
                ],
                "text": "Consulting Doctor"
              }
            ],
            "period": {
              "start": "2020-11-11T20:53:00-05:00"
            },
            "individual": {
              "reference": "Practitioner/4F69EC72C5AA48988E5E73832887E634"
            }
          },
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "CON",
                    "display": "consultant"
                  }
                ],
                "text": "Consulting Doctor"
              }
            ],
            "period": {
              "start": "2020-11-11T20:53:00-05:00"
            },
            "individual": {
              "reference": "Practitioner/D8A9F3EADBE041688ADD843BBD98CAB0"
            }
          },
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "ADM",
                    "display": "admitter"
                  }
                ],
                "text": "Admitting Doctor"
              }
            ],
            "period": {
              "start": "2020-11-11T20:53:00-05:00"
            },
            "individual": {
              "reference": "Practitioner/DF2821C049CC47E6A37C6B796DF4CF1D"
            }
          }
        ],
        "contained": [
          {
            "resourceType": "Location",
            "name": "Inferno",
            "id": "35202",
            "status": "active",
            "telecom": [
              {
                "system": "phone",
                "value": "6102196300"
              },
              {
                "system": "fax",
                "value": "6102196300"
              }
            ],
            "address": {
              "use": "work",
              "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States",
              "line": [
                "53 Valley Stream Parkway"
              ],
              "city": "Malvern",
              "state": "PA",
              "postalCode": "19355",
              "country": "United States"
            },
            "managingOrganization": {
              "reference": "Organization/HCU.1",
              "display": "Health Enterprise"
            }
          }
        ],
        "text": {
          "status": "generated",
          "div": "Encounter
Patient:Mcgovern,Astrid Santiago;
Status:in-progress;
Class:inpatient encounter;
Period Start Date:2020-04-15T16:42:00-04:00;
Service Provider:Health Enterprise;
Type:
System:http://terminology.hl7.org/CodeSystem/data-absent-reason Code:unknown Display:Unknown ;
Reason for Encounter - Chief Complaint:Pain left side of the body;
Location:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;
"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

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.