FHIR Encounter Resource

An interaction between a patient and healthcare provider(s) for the provision of services. This page documents the Encounter resource as served by the mock.health synthetic FHIR R4 sandbox — 6 search parameters, US Core 6.1 profiling, and the elements accepted on write.

Endpoints

• GET https://api.mock.health/fhir/Encounter — search
• GET https://api.mock.health/fhir/Encounter/{id} — read by logical id
• POST https://api.mock.health/fhir/Encounter — create (Pro)
• PUT https://api.mock.health/fhir/Encounter/{id} — update (Pro)

Search parameters

• patient (reference) — required — Patient participating in the encounter
• date (date) — Encounter date/period
• identifier (token) — External identifier
• type (token) — Encounter type code
• status (token) — planned | arrived | in-progress | finished
• class (token) — Classification (AMB, EMER, IMP)

US Core profiles

• us-core-encounter

Write elements

Fields accepted when creating or updating a Encounter. Required elements are base FHIR cardinality; the rest are US Core must-support.

• status (code) — required — planned | arrived | triaged | in-progress | onleave | finished
• class (Coding) — required — Classification — AMB (ambulatory), EMER (emergency), IMP (inpatient)
• subject (Reference(Patient)) — US Core MS — patient the encounter is with
• type (CodeableConcept[]) — US Core MS — encounter type (SNOMED CT)
• period (Period) — US Core MS — start and end time
• participant (BackboneElement[]) — US Core MS — practitioners involved in the encounter

Notes

Encounter resources include back-references to Condition resources in the diagnosis field, linking encounter diagnoses to their condition entries.

Specification

Base definition: HL7 FHIR R4 Encounter. Category: Encounters.

API reference · Quickstart · USCDI compliance · SMART on FHIR