Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

Encounter

This is a draft document. Please be aware that the contents are subject to change.

FHIR Encounter Resource

https://www.hl7.org/fhir/encounter.html

Overview

An Encounter is the FHIR term for what we call Discussions in the web UI (aka "conversations".)

It Encounter represents a quick summary of the discussion, as you might find in the inbox view of the web UI. It does not contain the actual contents (e.g. messages, documents, etc.)

Relevant Entities

Endpoints

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
searchGET/Encounter
  • patient. Required. Multi-value support: none. Modifier support: [<type>].
  • Patient
  • Professional
Retrieve Encounters for a specified Patient./Encounter?patient=Patient/ca9db36c-1b77-4d12-9246-d78fa5d13e8c

Mappings

FHIRPKBNotes
Resource id[[Encounter.Encounter ID]] 
Encounter.status"unknown"
Encounter.class
  • class: Coding
    • code = [[Message.Class]] of the most recent [[Message]] (as given by [[Message.Timestamp]])
    • system = "http://hl7.org/fhir/v3/ActCode"
Coding.code value mappings (PKB  FHIR):
  • IN_PATIENT → IMP
  • OUT_PATIENT → AMB
  • AMBULATORY → AMB
  • EMERGENCY → EMER
  • HOME → HH
  • FIELD → FLD
  • DAYTIME → SS
  • VIRTUAL → VR
  • OTHER → omit value
 
Encounter.period
  • period: Period
    • start = [[Message.Timestamp]] of the oldest message
    • end = [[Message.Timestamp]] of the newest message

Comments