Status
Released. Further enhancements planned.
Overview
An Encounter represents an interaction with the healthcare system, such as an inpatient stay.
Relevant PKB entities
Endpoints
Interaction |
HTTP |
URL |
Supported Parameters |
Permitted User Types |
Description |
Examples (more) |
search |
GET |
/Encounter |
- patient. Required. Multi-value support: none. Modifier support: [<type>].
- date. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt].
- _revinclude=Provenance:target
|
|
Retrieve Encounters for a specified Patient, optionally restricted by date range. |
/Encounter?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
/Encounter?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=gt2019-01-01 |
Mappings
FHIR |
PKB |
Notes |
Resource id |
[[Encounter.Encounter ID]] |
|
Encounter.extension |
Running through each [[Encounter Event]] from oldest to newest, add one "specialty-history" extension as follows for each block of consecutive [[Encounter Event]]s with the same [[Data Point.Specialty]] (where "the same" means an exact, case-sensitive match of the specialty value).
- extension[0]: Extension
- url = "http://fhir.patientsknowbest.com/structuredefinition/specialty-history"
- extension[0]
- url = "specialty"
- valueCoding: Coding
- code = [[Data Point.Specialty]]
- extension[1]
- url = "period"
- valuePeriod: Period
- start = [[Encounter Event.Timestamp]] of the oldest encounter event within the block being represented
- end = [[Encounter Event.Timestamp]] of the oldest encounter event within the block following the one being represented (if present)
|
|
Encounter.status |
"unknown" |
|
Encounter.class |
- class: Coding
- code = [[Encounter Event.Class]] of the most recent [[Encounter Event]] (as given by [[Encounter Event.Timestamp]])
- system = "http://hl7.org/fhir/v3/ActCode"
[[Encounter Event.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.classHistory |
Running through each [[Encounter Event]] from oldest to newest, add one entry to "classHistory" for each block of consecutive [[Encounter Event]]s with the same class value (where the class value is the FHIR value mapped from [[Encounter Event.Class]]). Do not add an entry if the value is OTHER.
- classHistory: BackboneElement
- class: Coding
- code = [[Encounter Event.Class]] of the block being represented (mappings as for Encounter.class)
- system = "http://hl7.org/fhir/v3/ActCode"
- period: Period
- start = [[Encounter Event.Timestamp]] of the oldest encounter event within the block being represented
- end = [[Encounter Event.Timestamp]] of the oldest encounter event within the block following the one being represented (if present)
|
|
Encounter.participant |
Running through each [[Encounter Event]] from oldest to newest, add one entry to "participant" for each block of consecutive [[Encounter Event]]s with the same [[Encounter Event→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 = [[Encounter Event→External Participant.Role]]
- period: Period
- start = [[Encounter Event.Timestamp]] of the oldest encounter event within the block being represented
- end = [[Encounter Event.Timestamp]] of the oldest encounter event within the block following the one being represented (if present)
- individual: Reference
- display = [[Encounter Event→External Participant.Name]]
[[Encounter Event→External Participant.Role]] code mappings (PKB → FHIR):
- ATTENDER → ATND
- REFERRER → REF
- CONSULTANT → CON
|
|
Encounter.period |
- period: Period
- start = [[Encounter Event.Timestamp]] of the oldest encounter event
- end = [[Encounter Event.Timestamp]] of the newest encounter event
|
|
Encounter.location |
Running through each [[Encounter Event]] from oldest to newest, add one entry to "location" for each block of consecutive [[Encounter Event]]s with the same [[Encounter Event->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 = [[Encounter Event->Location.Description]]
...and reference from the location list.
- location: BackboneElement
- location: Reference
- reference = a reference to the contained Location resource
- period: Period
- start = [[Encounter Event.Timestamp]] of the oldest encounter event within the block being represented
- end = [[Encounter Event.Timestamp]] of the oldest encounter event within the block following the one being represented (if present)
|
|
|
|