Encounter

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example Search by Patient
  • Example Search by ID
  • Errors
• Retrieve by ID
  • Authorization Types
  • Headers
  • Example
  • Errors

Overview

The Encounter resource provides admissions or visits during which health care services were provided to a patient. An encounter has a class to distinguish between different health care settings such as inpatient, outpatient, emergency, and so on.

Soarian Clinicals^® supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals^® at the time of the query.

The search results include the following fields if they contain values:

• Encounter id
• Encounter identifier
• Status
• Class
• Type
• Subject(Patient only)
• Participant:
  • Type
  • Start/end time of the participation
  • Individual
• Start/end time of the encounter
• Reason for visit
• Hospitalization:
  • Discharge disposition
• Location:
  • Location name
  • Location status
  • Location telecom
  • Location address
  • Location managing organization
• Service Provider (Organization)

Terminology Bindings

Encounter.type

Description The type of encounter. Details: CPT System: https://www.ama-assn.org/go/cpt

Encounter.participant.type

Description Role of participant in encounter. Details: ParticipantType System: https://terminology.hl7.org/CodeSystem/v3-ParticipationType

Encounter.reasonCode

Description Reason the encounter takes place. Details: ParticipantType System: https://hl7.org/fhir/sid/icd-9-cm and http://hl7.org/fhir/sid/icd-10-cm

Encounter.hospitalization.dischargeDisposition

Description Discharge Disposition. Details: Category or kind of location after discharge System: https://www.nubc.org/patient-discharge

Search

Search for Encounter resources that meet the specified query parameters:

GET /Encounter?:parameters

Implementation Notes

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

Authorization Types

Parameters

Name	Required?	Type	Description
_id	This, or patient	token	The logical resource ID associated with the resource
patient	This, or _id	reference	The patient who has the encounter.
date	No	date	Date range into which the encounter falls. Example: date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z
_revinclude	No	_revinclude	A request to include any Provenance resource in the bundle that refers to an Encounter resource in the search results. Only supported with Provenance.

Notes

• 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.
• The _revinclude parameter may be provided once with the value Provenance:target. 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.

Headers

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

Example Search by Patient

Request

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

Response

Status: 200 OK

{
  "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": "<div xmlns='http://www.w3.org/1999/xhtml'><b>Encounter</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:in-progress;<br /><b>Class</b>:inpatient encounter;<br /><b>Period Start Date</b>:2020-04-15T16:42:00-04:00;<br /><b>Service Provider</b>:Health Enterprise;<br /><b>Type</b>:<br /><b>System</b>:http://terminology.hl7.org/CodeSystem/data-absent-reason <b>Code</b>:unknown <b>Display</b>:Unknown ;<br /><b>Reason for Encounter - Chief Complaint</b>:Pain left side of the body;<br /><b>Location</b>:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example Search by ID

Request

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

Response

Status: 200 OK

{
  "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": "<div xmlns='http://www.w3.org/1999/xhtml'><b>Encounter</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:in-progress;<br /><b>Class</b>:inpatient encounter;<br /><b>Period Start Date</b>:2020-04-15T16:42:00-04:00;<br /><b>Service Provider</b>:Health Enterprise;<br /><b>Type</b>:<br /><b>System</b>:http://terminology.hl7.org/CodeSystem/data-absent-reason <b>Code</b>:unknown <b>Display</b>:Unknown ;<br /><b>Reason for Encounter - Chief Complaint</b>:Pain left side of the body;<br /><b>Location</b>:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Encounter?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by ID

List an individual Encounter resource by its ID:

GET /Encounter/:id

Implementation Notes

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

Authorization Types

Headers

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

Example

Request

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

Response

Status: 200 OK

{
  "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": "<div xmlns='http://www.w3.org/1999/xhtml'><b>Encounter</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:in-progress;<br /><b>Class</b>:inpatient encounter;<br /><b>Period Start Date</b>:2020-04-15T16:42:00-04:00;<br /><b>Service Provider</b>:Health Enterprise;<br /><b>Type</b>:<br /><b>System</b>:http://terminology.hl7.org/CodeSystem/data-absent-reason <b>Code</b>:unknown <b>Display</b>:Unknown ;<br /><b>Reason for Encounter - Chief Complaint</b>:Pain left side of the body;<br /><b>Location</b>:Inferno 53 Valley Stream Parkway,Malvern,PA,19355,United States;<br /></div>"
  }
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.