NHS North West Genomics
0.0.9 - ci-build United Kingdom flag

NHS North West Genomics - Local Development build (v0.0.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Encounter

Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/Encounter Version: 0.0.9
Draft as of 2025-11-14 Computable Name: Encounter
Keywords: Base, Patient Administration

Patient Administration Base, for implementation see

  • Hospital Spell - an admission (inpatient or outpatient)
  • Visit - an A&E attendance, a community contract, an OP attendance (Appointment), etc

Reference:

For detailed notes on FHIR Encounter in a NHS region, see Yorkshire and Humberside Care Record (YHCR) - FHIR Encounter (YHCR GitHub Repository)

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension: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
.... extension: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
.... extension: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
.... extension: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 ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known.
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... type SΣ 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter.
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... participant SΣ 0..* BackboneElement The list of people responsible for providing the service.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... period S 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
... reasonCode SΣ 0..* CodeableConcept Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from UKCoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* UKCoreEncounter An interaction during which services are provided to the patient
... identifier
.... value S 0..1 string The value that is unique
... type S 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType S 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... subject 1..1 Reference(Patient) The patient or group present at the encounter.
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... period S 0..1 Period The start and end time of the encounter
.... start S 0..1 dateTime Starting time with inclusive boundary
... hospitalization
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (required)
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... location
.... location
..... identifier 0..1 OrganisationSiteIdentifier Logical reference, when literal reference is not known
... serviceProvider
.... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.hospitalization.​admitSource Base required Admission Source 📦0.0.9 This IG
Encounter.hospitalization.​dischargeDisposition Base required Discharge Disposition 📦0.0.9 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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
.... extension: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
.... extension: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 ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown
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 0..* Extension Additional content defined by implementations
.... 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 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
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 0..* Extension Additional content defined by implementations
.... 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 1..1 Period The time that the episode was in the specified class
... type SΣ 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement The list of people responsible for providing the service.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... 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 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (required)
.... 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 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 OrganisationSiteIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.priority Base example ActPriority 📦3.0.0 THO v6.5
Encounter.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base required Admission Source 📦0.0.9 This IG
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base required Discharge Disposition 📦0.0.9 This IG
Encounter.location.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base preferred UK Core Encounter Location Type 📦1.0.0 fhir.r4.ukcore.stu3.currentbuild v0.0
Encounter.serviceProvider.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension: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
.... extension: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
.... extension: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
.... extension: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 ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known.
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... type SΣ 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter.
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... participant SΣ 0..* BackboneElement The list of people responsible for providing the service.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... period S 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
... reasonCode SΣ 0..* CodeableConcept Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from UKCoreEncounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* UKCoreEncounter An interaction during which services are provided to the patient
... identifier
.... value S 0..1 string The value that is unique
... type S 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType S 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... subject 1..1 Reference(Patient) The patient or group present at the encounter.
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... period S 0..1 Period The start and end time of the encounter
.... start S 0..1 dateTime Starting time with inclusive boundary
... hospitalization
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (required)
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... location
.... location
..... identifier 0..1 OrganisationSiteIdentifier Logical reference, when literal reference is not known
... serviceProvider
.... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.hospitalization.​admitSource Base required Admission Source 📦0.0.9 This IG
Encounter.hospitalization.​dischargeDisposition Base required Discharge Disposition 📦0.0.9 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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
.... extension: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
.... extension: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 ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown
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 0..* Extension Additional content defined by implementations
.... 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 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
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 0..* Extension Additional content defined by implementations
.... 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 1..1 Period The time that the episode was in the specified class
... type SΣ 0..1 CodeableConcept Specific type of encounter
Binding: Admission Method (required)
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service (required)
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement The list of people responsible for providing the service.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... 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 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (required)
.... 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 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 OrganisationSiteIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base required Admission Method 📦0.0.9 This IG
Encounter.serviceType Base required Service 📦0.0.9 This IG
Encounter.priority Base example ActPriority 📦3.0.0 THO v6.5
Encounter.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base required Admission Source 📦0.0.9 This IG
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base required Discharge Disposition 📦0.0.9 This IG
Encounter.location.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base preferred UK Core Encounter Location Type 📦1.0.0 fhir.r4.ukcore.stu3.currentbuild v0.0
Encounter.serviceProvider.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron