Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept United Kingdom flag

Care Coordination and 360 Referrals (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Hospital Spell

Official URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/HospitalSpell Version: 0.1.0
Draft as of 2026-11-03 Computable Name: HospitalSpell

Patient Administration - a hospital provider spell, identified by the Hospital Provider Spell Identifier (Account Number). Groups the Visits within it. Related to the Interweave EncounterGrouping. Copied from the NW GMSA FHIR IG.

FDP Canonical Data Model

Equivalent FDP Canonical Data Model (CDM) v1.0.0 objects: Admission, Ward Stay, Consultant Episode, Virtual Ward Stay.

Differences:

  • Good fit: CDM Admission is the Hospital Provider Spell, with admission source and method, discharge method and destination, and ward stays.
  • Account / Spell Number (AN): CDM admissionId / admissionExternalId - To confirm which is the spell number.
  • Discharge destination and method are separate in the CDM (destinationOfDischargeCode, methodOfDischargeCode), as in this profile (dischargeDisposition, Discharge Method).
  • Virtual ward stays are a separate CDM object with no link to the referral (basedOn).

The CDM is a downstream persistence model, used here as evidence of what NHS operations record, not as a design source. Mapping by property name - To confirm. See FDP Canonical Data Model Mapping for the full mapping.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.Slices for identifier This element must be supported. This element is included in summaries. 1..* CorrelationIdentifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. This element is included in summaries. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.type This element is included in summaries. 0..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element must be supported. This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The patient or group present at the encounter
Encounter.episodeOfCare This element must be supported. This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn This element must be supported. 0..* Reference(ServiceRequest) The referral this encounter carries out
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element is included in summaries. 1..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.type.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:referringDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:admittingDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.appointment This element must be supported. This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​dischargeDisposition Base extensible Discharge Destination 📦0.1.0 This IG

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 Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.Slices for identifier Content/Rules for all slices
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.Slices for participant 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.type 1..1 CodeableConcept Role of participant in encounter
Encounter.Slices for participant.participant:All Slices.type.coding 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.code 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:referringDoctor 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.type
Encounter.Slices for participant.participant:referringDoctor.type.coding 0..* Coding Code defined by a terminology system
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "REF"
}
Encounter.Slices for participant.participant:referringDoctor.individual
Encounter.Slices for participant.participant:referringDoctor.individual.identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:admittingDoctor 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.type
Encounter.Slices for participant.participant:admittingDoctor.type.coding 0..* Coding Code defined by a terminology system
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "ADM"
}
Encounter.Slices for participant.participant:admittingDoctor.individual
Encounter.Slices for participant.participant:admittingDoctor.individual.identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)
Encounter.partOf 0..0 Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.hospitalization.​admitSource Base extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​dischargeDisposition Base extensible Discharge Destination 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.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
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.Slices for identifier This element must be supported. This element is included in summaries. 1..* CorrelationIdentifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. This element is included in summaries. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element is included in summaries. 0..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element must be supported. This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The patient or group present at the encounter
Encounter.subject.id 0..1 string Unique id for inter-element referencing
Encounter.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.subject.type This element is included in summaries. 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).
Encounter.subject.identifier This element is included in summaries. 0..1 NHSIdentifier Logical reference, when literal reference is not known
Encounter.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.episodeOfCare This element must be supported. This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn This element must be supported. 0..* Reference(ServiceRequest) The referral this encounter carries out
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element is included in summaries. 1..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:All Slices.type.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:All Slices.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Encounter.Slices for participant.participant:All Slices.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:All Slices.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Encounter.Slices for participant.participant:All Slices.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Encounter.Slices for participant.participant:All Slices.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:All Slices.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:referringDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:referringDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:referringDoctor.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:referringDoctor.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:referringDoctor.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "REF"
}
Encounter.Slices for participant.participant:referringDoctor.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:referringDoctor.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:referringDoctor.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:referringDoctor.individual.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.individual.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:referringDoctor.individual.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.Slices for participant.participant:referringDoctor.individual.type This element is included in summaries. 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).
Encounter.Slices for participant.participant:referringDoctor.individual.identifier This element is included in summaries. 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:referringDoctor.individual.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.Slices for participant.participant:admittingDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:admittingDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:admittingDoctor.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:admittingDoctor.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:admittingDoctor.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "ADM"
}
Encounter.Slices for participant.participant:admittingDoctor.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:admittingDoctor.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:admittingDoctor.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:admittingDoctor.individual.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.individual.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:admittingDoctor.individual.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.Slices for participant.participant:admittingDoctor.individual.type This element is included in summaries. 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).
Encounter.Slices for participant.participant:admittingDoctor.individual.identifier This element is included in summaries. 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:admittingDoctor.individual.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.appointment This element must be supported. This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.period.id 0..1 string Unique id for inter-element referencing
Encounter.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Encounter.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element is included in summaries. 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)
Encounter.location 0..* BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(Location) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
Encounter.serviceProvider.id 0..1 string Unique id for inter-element referencing
Encounter.serviceProvider.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.serviceProvider.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.serviceProvider.type This element is included in summaries. 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).
Encounter.serviceProvider.identifier This element is included in summaries. 0..1 OrganisationCode Logical reference, when literal reference is not known
Encounter.serviceProvider.display This element is included in summaries. 0..1 string Text alternative for the resource

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.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 v7.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.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.participant:referringDoctor.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:referringDoctor.​individual.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.participant:admittingDoctor.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:admittingDoctor.​individual.type Base extensible ResourceType 📍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 extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.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 extensible Discharge Destination 📦0.1.0 This IG
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.
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()

This structure is derived from Encounter

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.participant

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.Slices for identifier This element must be supported. This element is included in summaries. 1..* CorrelationIdentifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. This element is included in summaries. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.type This element is included in summaries. 0..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element must be supported. This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The patient or group present at the encounter
Encounter.episodeOfCare This element must be supported. This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn This element must be supported. 0..* Reference(ServiceRequest) The referral this encounter carries out
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element is included in summaries. 1..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.type.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:referringDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:admittingDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.appointment This element must be supported. This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​dischargeDisposition Base extensible Discharge Destination 📦0.1.0 This IG

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 Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.Slices for identifier Content/Rules for all slices
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.Slices for participant 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.type 1..1 CodeableConcept Role of participant in encounter
Encounter.Slices for participant.participant:All Slices.type.coding 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.code 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:referringDoctor 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.type
Encounter.Slices for participant.participant:referringDoctor.type.coding 0..* Coding Code defined by a terminology system
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "REF"
}
Encounter.Slices for participant.participant:referringDoctor.individual
Encounter.Slices for participant.participant:referringDoctor.individual.identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:admittingDoctor 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.type
Encounter.Slices for participant.participant:admittingDoctor.type.coding 0..* Coding Code defined by a terminology system
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "ADM"
}
Encounter.Slices for participant.participant:admittingDoctor.individual
Encounter.Slices for participant.participant:admittingDoctor.individual.identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)
Encounter.partOf 0..0 Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.hospitalization.​admitSource Base extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​dischargeDisposition Base extensible Discharge Destination 📦0.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.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
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:dischargeMethod This element must be supported. 0..1 CodeableConcept Discharge Method
URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/DischargeMethod
Binding: Discharge Method Value Set (extensible)
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.Slices for identifier This element must be supported. This element is included in summaries. 1..* CorrelationIdentifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for identifier.identifier:HospitalSpellIdentifier This element must be supported. This element is included in summaries. 0..1 HospitalProviderSpellIdentifier Account Number / Spell Number (HL7 v2 type AN)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element is included in summaries. 0..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element must be supported. This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The patient or group present at the encounter
Encounter.subject.id 0..1 string Unique id for inter-element referencing
Encounter.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.subject.type This element is included in summaries. 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).
Encounter.subject.identifier This element is included in summaries. 0..1 NHSIdentifier Logical reference, when literal reference is not known
Encounter.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.episodeOfCare This element must be supported. This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn This element must be supported. 0..* Reference(ServiceRequest) The referral this encounter carries out
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element is included in summaries. 1..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:All Slices.type.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:All Slices.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Encounter.Slices for participant.participant:All Slices.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Encounter.Slices for participant.participant:All Slices.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Encounter.Slices for participant.participant:All Slices.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Encounter.Slices for participant.participant:All Slices.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Encounter.Slices for participant.participant:All Slices.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:All Slices.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:referringDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:referringDoctor.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:referringDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:referringDoctor.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:referringDoctor.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:referringDoctor.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "REF"
}
Encounter.Slices for participant.participant:referringDoctor.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:referringDoctor.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:referringDoctor.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:referringDoctor.individual.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:referringDoctor.individual.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:referringDoctor.individual.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.Slices for participant.participant:referringDoctor.individual.type This element is included in summaries. 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).
Encounter.Slices for participant.participant:referringDoctor.individual.identifier This element is included in summaries. 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:referringDoctor.individual.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.Slices for participant.participant:admittingDoctor This element must be supported. This element is included in summaries. 0..1 BackboneElement List of participants involved in the encounter
Encounter.Slices for participant.participant:admittingDoctor.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:admittingDoctor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:admittingDoctor.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:admittingDoctor.type.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:admittingDoctor.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
  "code" : "ADM"
}
Encounter.Slices for participant.participant:admittingDoctor.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Encounter.Slices for participant.participant:admittingDoctor.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:admittingDoctor.individual This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:admittingDoctor.individual.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:admittingDoctor.individual.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:admittingDoctor.individual.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.Slices for participant.participant:admittingDoctor.individual.type This element is included in summaries. 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).
Encounter.Slices for participant.participant:admittingDoctor.individual.identifier This element is included in summaries. 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
Encounter.Slices for participant.participant:admittingDoctor.individual.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.appointment This element must be supported. This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.period.id 0..1 string Unique id for inter-element referencing
Encounter.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Encounter.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element is included in summaries. 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admission Source (extensible)
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Discharge destination - where the patient went (PV1-37)
Binding: Discharge Destination (extensible)
Encounter.location 0..* BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(Location) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
Encounter.serviceProvider.id 0..1 string Unique id for inter-element referencing
Encounter.serviceProvider.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.serviceProvider.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.serviceProvider.type This element is included in summaries. 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).
Encounter.serviceProvider.identifier This element is included in summaries. 0..1 OrganisationCode Logical reference, when literal reference is not known
Encounter.serviceProvider.display This element is included in summaries. 0..1 string Text alternative for the resource

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.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 v7.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.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.participant:referringDoctor.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:referringDoctor.​individual.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.participant:admittingDoctor.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:admittingDoctor.​individual.type Base extensible ResourceType 📍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 extensible Admission Source 📦0.1.0 This IG
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.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 extensible Discharge Destination 📦0.1.0 This IG
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.
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()

This structure is derived from Encounter

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.participant

 

Other representations of profile: CSV, Excel, Schematron