Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.virtually.healthcare/StructureDefinition/Encounter | Version: 0.1.0-current | |||
Draft as of 2024-11-06 | Computable Name: Encounter |
Extension of UKCore-Encounter
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
dischargeMethod | N | 0..1 | CodeableConcept | An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital |
emergencyCareDischargeStatus | N | 0..1 | CodeableConcept | An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department |
legalStatus | N | 0..* | (Complex) | Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus |
OutcomeOfAttendance | N | 0..1 | CodeableConcept | An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
subject | SΣC | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
dischargeMethod | N | 0..1 | CodeableConcept | An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital | ||||
emergencyCareDischargeStatus | N | 0..1 | CodeableConcept | An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department | ||||
legalStatus | N | 0..* | (Complex) | Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus | ||||
OutcomeOfAttendance | N | 0..1 | CodeableConcept | An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | C | 1..1 | Period | The time that the episode was in the specified status per-1: If present, start SHALL have a lower value than end | ||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | C | 1..1 | Period | The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end | ||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: UK Core Encounter Type (preferred): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: UK Core Care Setting Type (preferred): Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΣC | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
episodeOfCare | ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided | ||||
basedOn | C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | C | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
individual | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided | ||||
appointment | ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
period | C | 0..1 | Period | The start and end time of the encounter per-1: If present, start SHALL have a lower value than end | ||||
length | C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | C | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
admissionMethod | N | 0..1 | CodeableConcept | An extension to support the method by which an individual was admitted into hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod Binding: UK Core Admission Method (extensible): The method by which a patient was admitted to hospital | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided | ||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: UK Core Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | C | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged ref-1: SHALL have a contained resource if a local reference is provided | ||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: UK Core Discharge Destination (preferred): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | C | 1..1 | Reference(Location) | Location the encounter takes place ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: UK Core Encounter Location Type (preferred): A set of codes that define the physical type of location where an encounter takes place. | |||||
period | C | 0..1 | Period | Time period during which the patient was present at the location per-1: If present, start SHALL have a lower value than end | ||||
serviceProvider | C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
partOf | C | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | preferred | UKCoreEncounterTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-EncounterType | ||||
Encounter.serviceType | preferred | UKCoreCareSettingTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | UKCoreSourceOfAdmissionhttps://fhir.hl7.org.uk/ValueSet/UKCore-SourceOfAdmission | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | UKCoreDischargeDestinationhttps://fhir.hl7.org.uk/ValueSet/UKCore-DischargeDestination | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | preferred | UKCoreEncounterLocationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-EncounterLocationType |
This structure is derived from UKCoreEncounter
Differential View
This structure is derived from UKCoreEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
dischargeMethod | N | 0..1 | CodeableConcept | An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital |
emergencyCareDischargeStatus | N | 0..1 | CodeableConcept | An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department |
legalStatus | N | 0..* | (Complex) | Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus |
OutcomeOfAttendance | N | 0..1 | CodeableConcept | An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
subject | SΣC | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | UKCoreEncounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
dischargeMethod | N | 0..1 | CodeableConcept | An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital | ||||
emergencyCareDischargeStatus | N | 0..1 | CodeableConcept | An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department | ||||
legalStatus | N | 0..* | (Complex) | Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus | ||||
OutcomeOfAttendance | N | 0..1 | CodeableConcept | An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | C | 1..1 | Period | The time that the episode was in the specified status per-1: If present, start SHALL have a lower value than end | ||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | C | 1..1 | Period | The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end | ||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: UK Core Encounter Type (preferred): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: UK Core Care Setting Type (preferred): Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΣC | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
episodeOfCare | ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided | ||||
basedOn | C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | C | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
individual | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided | ||||
appointment | ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
period | C | 0..1 | Period | The start and end time of the encounter per-1: If present, start SHALL have a lower value than end | ||||
length | C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
condition | ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | C | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
admissionMethod | N | 0..1 | CodeableConcept | An extension to support the method by which an individual was admitted into hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod Binding: UK Core Admission Method (extensible): The method by which a patient was admitted to hospital | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided | ||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: UK Core Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. | |||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | C | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged ref-1: SHALL have a contained resource if a local reference is provided | ||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: UK Core Discharge Destination (preferred): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
location | C | 1..1 | Reference(Location) | Location the encounter takes place ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: UK Core Encounter Location Type (preferred): A set of codes that define the physical type of location where an encounter takes place. | |||||
period | C | 0..1 | Period | Time period during which the patient was present at the location per-1: If present, start SHALL have a lower value than end | ||||
serviceProvider | C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
partOf | C | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | preferred | UKCoreEncounterTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-EncounterType | ||||
Encounter.serviceType | preferred | UKCoreCareSettingTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | UKCoreSourceOfAdmissionhttps://fhir.hl7.org.uk/ValueSet/UKCore-SourceOfAdmission | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | UKCoreDischargeDestinationhttps://fhir.hl7.org.uk/ValueSet/UKCore-DischargeDestination | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | preferred | UKCoreEncounterLocationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-EncounterLocationType |
This structure is derived from UKCoreEncounter
Other representations of profile: CSV, Excel, Schematron