Encounter

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

Status

In development. API spec subject to change.

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 PKB Entities

Endpoints

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
searchGET/Encounter
  • patient. Required. Multi-value support: none. Modifier support: [<type>].
  • _revinclude=Provenance:target
  • 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"
[[Message.Class]] code 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.classHistoryRunning through each [[Message]] from oldest to newest, add one entry to "classHistory" for each block of consecutive [[Message]]s with the same class value (where the class value is the FHIR value mapped from [[Message.Class]]). Do not add an entry if the value is OTHER.
  • classHistory: BackboneElement
    • class: Coding
      • code = [[Message.Class]] of the block being represented (mappings as for Encounter.class)
      • system = "http://hl7.org/fhir/v3/ActCode"
    • period: Period
      • start = [[Message.Timestamp]] of the oldest message within the block being represented
      • end = [[Message.Timestamp]] of the oldest message within the block following the one being represented (if present)
 
Encounter.participantRunning through each [[Message]] from oldest to newest, add one entry to "participant" for each block of consecutive [[Message]]s with the same [[Message→External Participant]] (where "the same" means an exact, case-sensitive match of the participant name).
  • participant: BackboneElement
    • type: CodeableConcept
      • coding[0]: Coding
        • system = "http://hl7.org/fhir/v3/ParticipationType"
        • code = [[Message→External Participant.Role]]
    • period: Period
      • start = [[Message.Timestamp]] of the oldest message within the block being represented
      • end = [[Message.Timestamp]] of the oldest message within the block following the one being represented (if present)
    • individual: Reference
      • display = [[Message→External Participant.Name]]
[[Message→External Participant.Role]] code mappings (PKB → FHIR):
  • ATTENDER → ATND
  • REFERRER → REF
  • CONSULTANT → CON
 
Encounter.period
  • period: Period
    • start = [[Message.Timestamp]] of the oldest message
    • end = [[Message.Timestamp]] of the newest message

Encounter.locationRunning through each [[Message]] from oldest to newest, add one entry to "location" for each block of consecutive [[Message]]s with the same [[Message->Location]] (where "the same" means an exact, case-sensitive match of the location description).

The location should be added as a contained Location resource to the response...
  • Location.description = [[Message->Location.Description]]
...and reference from the location list.
  • location: BackboneElement
    • location: Reference
      • reference = a reference to the contained Location resource
    • period: Period
      • start = [[Message.Timestamp]] of the oldest message within the block being represented
      • end = [[Message.Timestamp]] of the oldest message within the block following the one being represented (if present)
 
Comments