HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/encounter-eu-hdr | Version: 0.0.1-ci | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: EncounterEuHdr | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
This profile defines how to represent Inpatient Encounter in HL7 FHIR for the scope of this guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | Encounter | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |
identifier | 0..* | Identifier | Identifier(s) by which this encounter is known. | |
status | 1..1 | code | Status of this Hospital stay Binding: In-patient Encounter Type Value Set (required) | |
class | 1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |
type | 0..* | CodeableConcept | Specific type of Hospital stay Binding: In-patient 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 (HDR)) | 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 | |
participant:All Slices | Content/Rules for all slices | |||
individual | 0..1 | Reference(Practitioner (HDR) | PractitionerRole: (HDR) | 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 | |
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 | |
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 (preferred) | |
reasonReference | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |
diagnosis | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment | |
condition | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
hospitalization | ||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). | |
destination | 0..1 | Reference(Organization (HDR) | Location (HDR)) | Location/organization to which the patient is discharged | |
location | 0..* | BackboneElement | Locations where the patient stayed | |
location | 1..1 | Reference(Location (HDR)) | Location the encounter takes place | |
period | 0..1 | Period | Location period | |
serviceProvider | 0..1 | Reference(Organization (HDR)) | The organization (facility) responsible for this encounter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | |
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | |
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | |
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | |
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |
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 Hospital stay Binding: In-patient Encounter Type Value Set (required) |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) |
type | Σ | 0..* | CodeableConcept | Specific type of Hospital stay Binding: In-patient 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 (HDR)) | 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 |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
individual | Σ | 0..1 | Reference(Practitioner (HDR) | PractitionerRole: (HDR) | 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 |
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 |
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 |
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 |
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 |
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. | |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (preferred) |
reasonReference | Σ | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) |
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | Σ | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter |
location | 0..* | BackboneElement | Locations where the patient stayed | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | 1..1 | Reference(Location (HDR)) | Location the encounter takes place | |
period | 0..1 | Period | Location period | |
serviceProvider | 0..1 | Reference(Organization (HDR)) | The organization (facility) responsible for this encounter | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | |
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | |
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | |
Encounter.participant:admitter.type | extensible | Pattern: ADMhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:discharger.type | extensible | Pattern: DIShttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:referrer.type | extensible | Pattern: REFhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
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 Hospital stay Binding: In-patient Encounter Type 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 Hospital stay Binding: In-patient 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 (HDR)) | 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 | ||||
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 (HDR) | PractitionerRole: (HDR) | 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 (preferred) | ||||
reasonReference | Σ | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment | ||||
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) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 (HDR) | Location (HDR)) | 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 (HDR)) | 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 (HDR)) | The organization (facility) responsible for this encounter | |||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:admitter.type | extensible | Pattern: ADMhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:discharger.type | extensible | Pattern: DIShttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:referrer.type | extensible | Pattern: REFhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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(3 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
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | Encounter | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |
identifier | 0..* | Identifier | Identifier(s) by which this encounter is known. | |
status | 1..1 | code | Status of this Hospital stay Binding: In-patient Encounter Type Value Set (required) | |
class | 1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) | |
type | 0..* | CodeableConcept | Specific type of Hospital stay Binding: In-patient 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 (HDR)) | 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 | |
participant:All Slices | Content/Rules for all slices | |||
individual | 0..1 | Reference(Practitioner (HDR) | PractitionerRole: (HDR) | 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 | |
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 | |
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 (preferred) | |
reasonReference | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | |
diagnosis | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment | |
condition | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
hospitalization | ||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer). | |
destination | 0..1 | Reference(Organization (HDR) | Location (HDR)) | Location/organization to which the patient is discharged | |
location | 0..* | BackboneElement | Locations where the patient stayed | |
location | 1..1 | Reference(Location (HDR)) | Location the encounter takes place | |
period | 0..1 | Period | Location period | |
serviceProvider | 0..1 | Reference(Organization (HDR)) | The organization (facility) responsible for this encounter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | |
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | |
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | |
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | |
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |
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 Hospital stay Binding: In-patient Encounter Type Value Set (required) |
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: Encounter Class Value Set (extensible) |
type | Σ | 0..* | CodeableConcept | Specific type of Hospital stay Binding: In-patient 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 (HDR)) | 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 |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
individual | Σ | 0..1 | Reference(Practitioner (HDR) | PractitionerRole: (HDR) | 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 |
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 |
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 |
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 |
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 |
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. | |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: Condition Value Set (preferred) |
reasonReference | Σ | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) |
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | Σ | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter |
location | 0..* | BackboneElement | Locations where the patient stayed | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | 1..1 | Reference(Location (HDR)) | Location the encounter takes place | |
period | 0..1 | Period | Location period | |
serviceProvider | 0..1 | Reference(Organization (HDR)) | The organization (facility) responsible for this encounter | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | |
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | |
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | |
Encounter.participant:admitter.type | extensible | Pattern: ADMhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:discharger.type | extensible | Pattern: DIShttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:referrer.type | extensible | Pattern: REFhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
note | 0..* | Annotation | Enconter note URL: http://hl7.org/fhir/StructureDefinition/note | |||||
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 Hospital stay Binding: In-patient Encounter Type 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 Hospital stay Binding: In-patient 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 (HDR)) | 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 | ||||
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 (HDR) | PractitionerRole: (HDR) | 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 (preferred) | ||||
reasonReference | Σ | 0..* | Reference(Observation | Condition | Procedure) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter, see comment | ||||
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) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 (HDR) | Location (HDR)) | 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 (HDR)) | 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 (HDR)) | The organization (facility) responsible for this encounter | |||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.status | required | EncounterStatusHdrVShttp://hl7.eu/fhir/hdr/ValueSet/encounter-status-eu-hdr from this IG | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | EncounterClassHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounterClass-eu-hdr from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | EncounterTypeHdrVShttp://hl7.eu/fhir/hdr/ValueSet/hdr-encounter-type-eu-hdr from this IG | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | preferred | AdmissionUrgencyHdrVShttp://hl7.eu/fhir/hdr/ValueSet/admission-urgency-eu-hdr from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:admitter.type | extensible | Pattern: ADMhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:discharger.type | extensible | Pattern: DIShttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:referrer.type | extensible | Pattern: REFhttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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(3 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