HL7 Europe Discharge Report
1.0.0-ci-build - ci-build
150
HL7 Europe Discharge Report
1.0.0-ci-build - ci-build
150
HL7 Europe Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/discharge-report/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/discharge-report/StructureDefinition/encounter-eu-dr | Version: 1.0.0-ci-build | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EncounterEuDr | ||
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0). |
||||
This profile defines how to represent the encounter documented by a Discharge Report in HL7 FHIR for the scope of this guide. The encounter may be of any kind leading to a discharge, for example an inpatient hospital stay, an emergency department visit, a day-care episode, a rehabilitation stay or an ambulatory episode.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
 text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
   extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
 extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |||||
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |||||
| class |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |||||
| type |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |||||
| serviceType |
0..1 | CodeableConcept | Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |||||
 subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |||||
 Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |||||
  participant:All Slices |
Content/Rules for all slices | |||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | Reference(Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:admitter |
0..* | BackboneElement | Admitting professional | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
 type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
| display |
0..1 | string | Representation defined by the system | |||||
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
 individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:discharger |
0..* | BackboneElement | Discharging professional | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
 type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
 participant:referrer |
0..* | BackboneElement | Referring professional | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| period |
0..1 | Period | The start and end time of this encounter. | |||||
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |||||
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |||||
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| diagnosis:All Slices |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |||||
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to and the discharge from the healthcare service | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| destination |
0..1 | Reference(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | Locations where the patient stayed | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| location |
1..1 | Reference(Location (EU core)) | Location the encounter takes place | |||||
| period |
0..1 | Period | Location period | |||||
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.participant:admitter.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:discharger.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:referrer.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
| Encounter.diagnosis:admission.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:discharge.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
Encounter | |||
| language |
0..1 | code | Language of the resource content | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |
| extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |
| class |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |
| type |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |
| serviceType |
0..1 | CodeableConcept | Specific type of service. | |
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |
| subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |
| Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |
| participant:All Slices |
Content/Rules for all slices | |||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |
| individual |
0..1 | Reference(Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |
| participant:admitter |
0..* | BackboneElement | Admitting professional | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| participant:discharger |
0..* | BackboneElement | Discharging professional | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| period |
0..1 | Period | The start and end time of this encounter. | |
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| diagnosis:All Slices |
Content/Rules for all slices | |||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |
| use |
1..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) 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/diagnosis-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |
| use |
1..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) 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/diagnosis-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to and the discharge from the healthcare service | |
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). | |
| destination |
0..1 | Reference(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge | |
| location |
0..* | BackboneElement | Locations where the patient stayed | |
| location |
1..1 | Reference(Location (EU core)) | Location the encounter takes place | |
| period |
0..1 | Period | Location period | |
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
| extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |||||
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |||||
| 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 |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |||||
| 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 |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |||||
| serviceType |
0..1 | CodeableConcept | Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |||||
| subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |||||
| episodeOfCare |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |||||
| Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| 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 (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:admitter |
0..* | BackboneElement | Admitting professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 | |||||
| participant:discharger |
0..* | BackboneElement | Discharging professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 | |||||
| participant:referrer |
0..* | BackboneElement | Referring professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 |
0..1 | Period | The start and end time of this encounter. | |||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |||||
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |||||
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| diagnosis:All Slices |
Content/Rules for all slices | |||||||
| 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) | 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) | |||||
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 and the discharge from the healthcare 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 | |||||
| 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: AdmitSource (preferred): From where the patient was admitted. | |||||
| 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(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | Locations where the patient stayed | |||||
| 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 (EU core)) | Location the encounter takes place | |||||
| 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: LocationType (example): Physical form of the location. | |||||
| period |
0..1 | Period | Location period | |||||
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:admitter.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:discharger.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:referrer.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:admission.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:discharge.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| 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 | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| 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: 1 element(5 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
| extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |||||
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |||||
| class |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |||||
| type |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |||||
| serviceType |
0..1 | CodeableConcept | Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |||||
| subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |||||
| Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | Reference(Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:admitter |
0..* | BackboneElement | Admitting professional | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:discharger |
0..* | BackboneElement | Discharging professional | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| participant:referrer |
0..* | BackboneElement | Referring professional | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| period |
0..1 | Period | The start and end time of this encounter. | |||||
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |||||
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |||||
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| diagnosis:All Slices |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |||||
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to and the discharge from the healthcare service | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| destination |
0..1 | Reference(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | Locations where the patient stayed | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| location |
1..1 | Reference(Location (EU core)) | Location the encounter takes place | |||||
| period |
0..1 | Period | Location period | |||||
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.participant:admitter.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:discharger.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:referrer.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
| Encounter.diagnosis:admission.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:discharge.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
Encounter | |||
| language |
0..1 | code | Language of the resource content | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |
| extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |
| class |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |
| type |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |
| serviceType |
0..1 | CodeableConcept | Specific type of service. | |
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |
| subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |
| Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |
| participant:All Slices |
Content/Rules for all slices | |||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |
| individual |
0..1 | Reference(Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |
| participant:admitter |
0..* | BackboneElement | Admitting professional | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| participant:discharger |
0..* | BackboneElement | Discharging professional | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| type |
1..* | CodeableConcept | Role of participant in encounter 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 | |
| individual |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| period |
0..1 | Period | The start and end time of this encounter. | |
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| diagnosis:All Slices |
Content/Rules for all slices | |||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |
| use |
1..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) 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/diagnosis-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |
| use |
1..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) 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/diagnosis-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to and the discharge from the healthcare service | |
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). | |
| destination |
0..1 | Reference(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge | |
| location |
0..* | BackboneElement | Locations where the patient stayed | |
| location |
1..1 | Reference(Location (EU core)) | Location the encounter takes place | |
| period |
0..1 | Period | Location period | |
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:note |
0..* | Annotation | Encounter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
| extension:legalStatus |
0..* | (Complex) | Legal status/situation at admission URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus Binding: Example of Legal Status at admission Value Set (example) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known. | |||||
| status |
1..1 | code | Status of this encounter Binding: Encounter Status Value Set (required) | |||||
| 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 |
1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |||||
| 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 |
0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type Value Set (example) | |||||
| serviceType |
0..1 | CodeableConcept | Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
0..1 | CodeableConcept | Encounter priority Binding: Admission Urgency Value Set (preferred) | |||||
| subject |
1..1 | Reference(Patient (EU core)) | The patient present at the encounter | |||||
| episodeOfCare |
0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The request for which this encounter has been made | |||||
| Slices for participant |
0..* | BackboneElement | List of participants involved in the encounters 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 | |||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| 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 (EU core) | PractitionerRole (EU core) | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| participant:admitter |
0..* | BackboneElement | Admitting professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 | |||||
| participant:discharger |
0..* | BackboneElement | Discharging professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 | |||||
| participant:referrer |
0..* | BackboneElement | Referring professional | |||||
| 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 |
1..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 |
0..1 | Period | The start and end time of this encounter. | |||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (DR) (preferred) | |||||
| reasonReference |
0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |||||
| Slices for diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| diagnosis:All Slices |
Content/Rules for all slices | |||||||
| 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) | 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) | |||||
| diagnosis:admission |
0..* | BackboneElement | Admission diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| diagnosis:discharge |
0..* | BackboneElement | Discharge diagnosis | |||||
| 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 |
1..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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/diagnosis-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 and the discharge from the healthcare 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 | |||||
| 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: AdmitSource (preferred): From where the patient was admitted. | |||||
| 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(Organization (EU core) | Location (EU core)) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | Locations where the patient stayed | |||||
| 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 (EU core)) | Location the encounter takes place | |||||
| 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: LocationType (example): Physical form of the location. | |||||
| period |
0..1 | Period | Location period | |||||
| serviceProvider |
0..1 | Reference(Organization (EU core)) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | Encounter Class Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | Encounter Type Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | preferred | Admission Urgency Value Set | 📦1.0.0-ci-build | This IG |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:admitter.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:discharger.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.participant:referrer.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Condition Value Set (DR) | 📦1.0.0-ci-build | This IG |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:admission.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis:discharge.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| 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 | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| 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: 1 element(5 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2026+ HL7 Europe. Package hl7.fhir.eu.discharge-report#1.0.0-ci-build based on FHIR 4.0.1. Generated 2026-10-06
