Encounter REST Endpoints

Sort by

Task Path Method

Description

Encounter

This topic describes information for the Encounter resource.

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.

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.

Error: The common Client Errors (for more information, see unresolvable-reference.html) and OperationOutcomes may be returned.

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

• Encounter ID
• Encounter identifier
• Status
• Class
• Type
• Service Type
• Priority

• Subject (Patient Only)

• Participant:

  • Type

  • Start/end time of the participation

  • Individual

• Start/end time of the Encounter
• Reason for visit
• Incident
• Admitting diagnoses
• Administrative problem

• Hospitalization:

  • Discharge disposition

• Location:

  • Location name
  • Location status
  • Location telecom
  • Location address
  • Location managing organization
• Service provider

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

Encounter

The operations from the Encounter category.

Get a list of encounters

Method: get

Path: /Encounter

Get an encounter by ID

Method: get

Path: /Encounter/{ID}