Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.4.1.534 ValueSet http://hl7.org/fhir/ValueSet/encounter-status

Patient Administration icon Work Group   Maturity Level : 2 Trial Use Use Context : Any

This is a value set defined by the FHIR project.

Summary

Defining URL: http://hl7.org/fhir/ValueSet/encounter-status
Version: 5.0.0-ballot
Name: EncounterStatus
Title: EncounterStatus
Status: draft
Definition:

Current state of the encounter.

Committee: Patient Administration icon Profiles & Extensions Work Group
OID: 2.16.840.1.113883.4.642.3.246 (for OID based terminology systems)
Flags: Immutable

This value set is used in the following places:


11.7.9

 

This expansion generated 10 Sep 2022


This value set contains 9 concepts

Expansion based on EncounterStatus v5.0.0-ballot (CodeSystem)

Maturity Level : N/A Standards Status : Informative Compartments : Patient , Practitioner 11.7.9.1
Code Public Health and Emergency Response System Display Definition Canonical Mapping for "EncounterStatus" Work Group
   planned http://hl7.org/fhir/encounter-status Planned

The Encounter has not yet started.

Security Category : Patient ~ planned
   in-progress http://hl7.org/fhir/encounter-status In Progress

The Encounter has begun and the patient is present / the practitioner and the patient are meeting.

~ active
   onhold http://hl7.org/fhir/encounter-status On Hold

R3 : R4 Conversion maps for Immunization. The Encounter has begun, but is currently on hold, e.g. because the patient is temporarily on leave.

~ suspended
   discharged http://hl7.org/fhir/encounter-status Discharged

Functional status for The Encounter has been clinically completed, the patient has been discharged from the facility or the visit has ended, and the patient may have departed (refer to subjectStatus). While the encounter is in this map: 3 tests that status, administrative activities are usually performed, collating all execute ok. All tests pass round-trip testing required documentation and 3 r3 resources are invalid (0 errors). charge information before being released for billing, at which point the status will move to completed.

~ ( see documentation) partial
   completed http://hl7.org/fhir/encounter-status Completed

The Encounter has ended.

~ R3 to R4 complete
   cancelled map "http://hl7.org/fhir/StructureMap/Immunization3to4" = "R3 to R4 Conversions for Immunization" uses "http://hl7.org/fhir/3.0/StructureDefinition/Immunization" alias ImmunizationR3 as source uses "http://hl7.org/fhir/StructureDefinition/Immunization" alias Immunization as target imports "http://hl7.org/fhir/StructureMap/*3to4" group Immunization(source src : ImmunizationR3, target tgt : Immunization) extends DomainResource <<type+>> { src.identifier -> tgt.identifier; src.status -> tgt.status; src.notGiven where value = true -> tgt.status = 'not-done'; src.notGiven as v -> tgt.extension as vt, vt.url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.notGiven', vt.value = v; src.vaccineCode -> tgt.vaccineCode; src.patient -> tgt.patient; src.encounter -> tgt.encounter; src.date as vs -> tgt.occurrence = create('dateTime') as vt then dateTime(vs, vt); src.primarySource -> tgt.primarySource; src.reportOrigin -> tgt.reportOrigin; src.location -> tgt.location; src.manufacturer -> tgt.manufacturer; src.lotNumber -> tgt.lotNumber; src.expirationDate -> tgt.expirationDate; src.site -> tgt.site; src.route -> tgt.route; src.doseQuantity -> tgt.doseQuantity; src.practitioner as vs -> tgt.performer as vt then practitioner(vs, vt); src.note -> tgt.note; src.explanation as s then { s.reason -> tgt.reasonCode; s.reasonNotGiven -> tgt.reasonCode; }; src.reaction as vs -> tgt.reaction as vt then reaction(vs, vt); src.vaccinationProtocol as vs -> tgt.protocolApplied as vt then protocol(vs, vt); } group practitioner(source src, target tgt) extends BackboneElement { src.role -> tgt.function; src.actor -> tgt.actor; } group reaction(source src, target tgt) extends BackboneElement { src.date -> tgt.date; src.detail -> tgt.detail; src.reported -> tgt.reported; } group protocol(source src, target tgt) extends BackboneElement { src.doseSequence as vs -> tgt.doseNumber = create('positiveInt') as vt then positiveInt(vs, vt); src.description as v -> tgt.extension as vt, vt.url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.description', vt.value = v; src.authority -> tgt.authority; src.series -> tgt.series; src.seriesDoses as vs -> tgt.seriesDoses = create('positiveInt') as vt then positiveInt(vs, vt); src.targetDisease -> tgt.targetDisease; src.doseStatus as v -> tgt.extension as vt, vt.url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatus', vt.value = v; src.doseStatusReason as v -> tgt.extension as vt, vt.url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatusReason', vt.value = v; } http://hl7.org/fhir/encounter-status Cancelled

The Encounter has ended before it has begun.

11.7.9.2
~ R4 failed
   discontinued http://hl7.org/fhir/encounter-status Discontinued

The Encounter has started, but was not able to R3 be completed. Further action may need to be performed, such as rescheduling appointments related to this encounter.

~ abandoned
   entered-in-error map "http://hl7.org/fhir/StructureMap/Immunization4to3" = "R4 to R3 Conversion for Immunization" uses "http://hl7.org/fhir/StructureDefinition/Immunization" alias Immunization as source uses "http://hl7.org/fhir/3.0/StructureDefinition/Immunization" alias ImmunizationR3 as target imports "http://hl7.org/fhir/StructureMap/*4to3" group Immunization(source src : Immunization, target tgt : ImmunizationR3) extends DomainResource <<type+>> { src.identifier -> tgt.identifier; src.status where value != 'not-done' -> tgt.status; src.status where value = 'not-done' -> tgt.status = 'completed', tgt.notGiven = true; src.extension as e where url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.notGiven' then { e.value -> tgt.notGiven; }; src.vaccineCode -> tgt.vaccineCode; src.patient -> tgt.patient; src.encounter -> tgt.encounter; src.occurrence : dateTime as vs -> tgt.date as vt then dateTime(vs, vt); src.primarySource -> tgt.primarySource; src.reportOrigin -> tgt.reportOrigin; src.location -> tgt.location; src.manufacturer -> tgt.manufacturer; src.lotNumber -> tgt.lotNumber; src.expirationDate -> tgt.expirationDate; src.site -> tgt.site; src.route -> tgt.route; src.doseQuantity -> tgt.doseQuantity; src.performer as vs -> tgt.practitioner as vt then practitioner(vs, vt); src.note -> tgt.note; src.reasonCode as vs where src.status != 'not-done' -> tgt.explanation as t, t.reason = vs; src.reasonCode as vs where src.status = 'not-done' -> tgt.explanation as t, t.reasonNotGiven = vs; src.reaction as vs -> tgt.reaction as vt then reaction(vs, vt); src.protocolApplied as vs -> tgt.vaccinationProtocol as vt then protocol(vs, vt); } group practitioner(source src, target tgt) extends BackboneElement { src.function -> tgt.role; src.actor -> tgt.actor; } group reaction(source src, target tgt) extends BackboneElement { src.date -> tgt.date; src.detail -> tgt.detail; src.reported -> tgt.reported; } group protocol(source src, target tgt) extends BackboneElement { src.doseNumber : positiveInt as vs -> tgt.doseSequence as vt then positiveInt(vs, vt); src.extension as e where url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.description' then { e.value -> tgt.description; }; src.authority -> tgt.authority; src.series -> tgt.series; src.seriesDoses : positiveInt as vs -> tgt.seriesDoses as vt then positiveInt(vs, vt); src.targetDisease -> tgt.targetDisease; src.extension as e where url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatus' then { e.value -> tgt.doseStatus; }; src.extension as e where url = 'http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatusReason' then { e.value -> tgt.doseStatusReason; }; } http://hl7.org/fhir/encounter-status Entered in Error

This instance should not have been part of this patient's medical record.

11.7.9.3
~ error
   unknown http://hl7.org/fhir/encounter-status Unknown

The encounter status is unknown. Note that "unknown" is a value of last resort and every attempt should be made to provide a meaningful value other than "unknown".

~ R4 Validation Errors unknown

 

See the full registry of value sets defined as part of FHIR.


Explanation of the columns that may appear on this page:

<p>No validation errors
Lvl A few code lists that FHIR defines are hierarchical - all conversions each code is assigned a level. For value sets, levels are clean</p> mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code