Encounter REST Endpoints

Sort by

Task Path Method

Description

Encounter

This topic describes information for the Encounter resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

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

Profile Support

This resource supports the US Core Encounter Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Encounter	DomainResource
Encounter.identifier	Identifier
Encounter.identifier.system	uri
Encounter.identifier.value	string
Encounter.status	code
Encounter.class	Coding
Encounter.type	CodeableConcept
Encounter.subject	Reference(Patient)
Encounter.participant	BackboneElement
Encounter.participant.type	CodeableConcept
Encounter.participant.period	Period
Encounter.participant.individual	Reference Practitioner RelatedPerson
Encounter.period	Period
Encounter.reasonCode	CodeableConcept
Encounter.reasonReference	Reference Condition Procedure Observation
Encounter.hospitalization	BackboneElement
Encounter.hospitalization.dischargeDisposition	CodeableConcept
Encounter.location	BackboneElement
Encounter.location.location	Reference(Location)
Encounter.serviceProvider	Reference(Organization)

Terminology Bindings

Element	Description	Details
Encounter.status	The state of the encounter throughout its lifecycle.	System
Encounter.class	The concepts representing the classification of the patient encounter such as ambulatory (outpatient), inpatient, emergency, home health, or others due to local variations.	System
Encounter.type	The specific type of encounter (for example, email consultation, surgical day-care, skilled nursing, rehabilitation).	System SNOMED CT
Encounter.participant.type	The role of the participant in the encounter.	System
Encounter.hospitalization.dischargeDisposition	The category or type of location after discharge.	System

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}