XpanDH Hospital Discharge Report
0.1.0 - ci-build 150

XpanDH Hospital Discharge Report, published by XpanDH Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xpandh-hdr/ and changes regularly. See the Directory of published versions

Resource Profile: Inpatient Encounter Xpandh

Official URL: http://hl7.eu/fhir/ig/xpandh/hdr/StructureDefinition/inpatient-encounter-hdr-xpandh Version: 0.1.0
Draft as of 2025-01-06 Computable Name: InpatientEncounterHDRXpandh

Copyright/Legal: Used by permission of the XpanDH project, all rights reserved Creative Commons License

This profile defines how to represent Inpatient Encounter in FHIR for the purpose of the XpanDH Hospital Discharge Report.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known.
ele-1: All FHIR elements must have a @value or children
... class Σ 1..1 Coding Classification of patient encounter
Binding: Encounter Class Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
... type Σ 0..* CodeableConcept Specific type of Hospital stay
Binding: In-patient Encounter Type Value Set (example)
ele-1: All FHIR elements must have a @value or children
... serviceType Σ 0..1 CodeableConcept Specific type of service.
Binding: ServiceType (example): Broad categorization of the service that is to be provided.


ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Encounter priority
Binding: Admission Urgency Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient: HDR) The patient present at the encounter
ele-1: All FHIR elements must have a @value or children
... basedOn 0..* Reference(ServiceRequest) The request for which this encounter has been made
ele-1: All FHIR elements must have a @value or children
... Slices for participant Σ 0..* BackboneElement List of participants involved in the encounters
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
ele-1: All FHIR elements must have a @value or children
.... participant:admitter Σ 0..* BackboneElement Admitting professional
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type Σ 1..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ADM
.... participant:discharger Σ 0..* BackboneElement Discharging professional
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type Σ 1..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DIS
.... participant:referrer Σ 0..* BackboneElement Referring professional
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type Σ 1..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: REF
... period 0..1 Period The start and end time of this encounter.
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: Condition Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference Σ 0..* Reference(Observation | Condition | Procedure) Reason the encounter takes place (reference)
ele-1: All FHIR elements must have a @value or children
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter, see comment
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
ele-1: All FHIR elements must have a @value or children
... location 0..* BackboneElement Locations where the patient stayed
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... location 1..1 Reference(Location) Location the encounter takes place
ele-1: All FHIR elements must have a @value or children
.... period 0..1 Period Location period
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.statusrequiredEncounterStatusHdrVS
http://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/encounter-status-vs-eu-hdr
from this IG
Encounter.classextensibleHdrEncounterClassXpandhVS
http://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-encounterClass-xpandh-vs
from this IG
Encounter.typeexampleHdrEncounterTypeXpandhVS
http://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-encounter-type-xpandh-vs
from this IG
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.prioritypreferredHdrAdmissionUrgencyXpandhVS
http://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-admission-urgency-xpandh-vs
from this IG
Encounter.participant:admitter.typeextensiblePattern: ADM
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.participant:discharger.typeextensiblePattern: DIS
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.participant:referrer.typeextensiblePattern: REF
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredHdrConditionXpandhVS
http://hl7.eu/fhir/ig/xpandh/hdr/ValueSet/hdr-condition-xpandh-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron