HdBe-Encounter

Profile	Status	URL
HdBe-Encounter	draft	https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Encounter

Encounter		Encounter	There are no (further) constraints on this element Element Id Encounter Short description Encounter Definition Root concept of the Contact information model. This concept contains all data elements of the Contact information model. Data Type Encounter
ContactType	1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Encounter.ContactType Short description ContactType Definition The type of contact. Data Type CodeableConcept Binding ContactType codes ContactType (extensible)
ContactWith	0..*	Reference(HdBe HealthProfessional)	There are no (further) constraints on this element Element Id Encounter.ContactWith Short description ContactWith Definition The health professional with whom the contact took or will take place. The specialty and role of the health professional can be entered in the HealthProfessional information model. Data Type Reference(HdBe HealthProfessional)
Location	0..1	Reference(HdBe HealthcareOrganization)	There are no (further) constraints on this element Element Id Encounter.Location Short description Location Definition The physical location at which the contact took or will take place. Data Type Reference(HdBe HealthcareOrganization)
StartDateTime	1..1	dateTime	There are no (further) constraints on this element Element Id Encounter.StartDateTime Short description StartDateTime Definition The date and time at which the contact took or will take place. Data Type dateTime
EndDateTime	0..1	dateTime	There are no (further) constraints on this element Element Id Encounter.EndDateTime Short description EndDateTime Definition The date and time at which the contact ended or will end. If the contact takes place over a period of time, this indicates the end of the period, in the case of an admission, for example. Data Type dateTime
ContactReason	0..*	BackboneElement	There are no (further) constraints on this element Element Id Encounter.ContactReason Short description ContactReason Definition Container of the ContactReason concept. This container contains all data elements of the ContactReason concept. Data Type BackboneElement
Problem	0..*	Reference(HdBe Problem)	There are no (further) constraints on this element Element Id Encounter.ContactReason.Problem Short description Problem Definition The problem that is the reason for the contact. Data Type Reference(HdBe Problem)
Procedure	0..*	Reference(HdBe Procedure)	There are no (further) constraints on this element Element Id Encounter.ContactReason.Procedure Short description Procedure Definition The procedure carried out or will be carried out during the contact. Data Type Reference(HdBe Procedure)
DeviatingResult	0..*	string	There are no (further) constraints on this element Element Id Encounter.ContactReason.DeviatingResult Short description DeviatingResult Definition A deviating result which serves as the reason for the contact. Data Type string
CommentContactReason	0..1	string	There are no (further) constraints on this element Element Id Encounter.ContactReason.CommentContactReason Short description CommentContactReason Definition Explanation of the reason for the contact Data Type string
Origin	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Encounter.Origin Short description Origin Definition Location from which the patient comes before the encounter. In most cases this will only be used when the patient is admitted. Data Type CodeableConcept Binding Origin codes Origin (extensible)
Destination	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Encounter.Destination Short description Destination Definition Location to which the patient will go after the encounter. In most cases this will only be used when the patient is discharged. Data Type CodeableConcept Binding Destination codes Destination (extensible)

Encounter		0..*
Encounter.ContactType	CodeableConcept	1..1
Encounter.ContactWith	Reference(HdBe HealthProfessional)	0..*
Encounter.Location	Reference(HdBe HealthcareOrganization)	0..1
Encounter.StartDateTime	dateTime	1..1
Encounter.EndDateTime	dateTime	0..1
Encounter.ContactReason	BackboneElement	0..*
Encounter.ContactReason.Problem	Reference(HdBe Problem)	0..*
Encounter.ContactReason.Procedure	Reference(HdBe Procedure)	0..*
Encounter.ContactReason.DeviatingResult	string	0..*
Encounter.ContactReason.CommentContactReason	string	0..1
Encounter.Origin	CodeableConcept	0..1
Encounter.Destination	CodeableConcept	0..1

Encounter
Definition	Root concept of the Contact information model. This concept contains all data elements of the Contact information model.
Cardinality	0...*
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
Encounter.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Encounter.ContactType
Definition	The type of contact.
Cardinality	1...1
Type	CodeableConcept
Binding	ContactType codes ContactType (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
Encounter.ContactWith
Definition	The health professional with whom the contact took or will take place. The specialty and role of the health professional can be entered in the HealthProfessional information model.
Cardinality	0...*
Type	Reference(HdBe HealthProfessional)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Encounter.Location
Definition	The physical location at which the contact took or will take place.
Cardinality	0...1
Type	Reference(HdBe HealthcareOrganization)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Encounter.StartDateTime
Definition	The date and time at which the contact took or will take place.
Cardinality	1...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.EndDateTime
Definition	The date and time at which the contact ended or will end. If the contact takes place over a period of time, this indicates the end of the period, in the case of an admission, for example.
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.ContactReason
Definition	Container of the ContactReason concept. This container contains all data elements of the ContactReason concept.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.ContactReason.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
Encounter.ContactReason.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Encounter.ContactReason.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Encounter.ContactReason.Problem
Definition	The problem that is the reason for the contact.
Cardinality	0...*
Type	Reference(HdBe Problem)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Encounter.ContactReason.Procedure
Definition	The procedure carried out or will be carried out during the contact.
Cardinality	0...*
Type	Reference(HdBe Procedure)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Encounter.ContactReason.DeviatingResult
Definition	A deviating result which serves as the reason for the contact.
Cardinality	0...*
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.ContactReason.CommentContactReason
Definition	Explanation of the reason for the contact
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
Encounter.Origin
Definition	Location from which the patient comes before the encounter. In most cases this will only be used when the patient is admitted.
Cardinality	0...1
Type	CodeableConcept
Binding	Origin codes Origin (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
Encounter.Destination
Definition	Location to which the patient will go after the encounter. In most cases this will only be used when the patient is discharged.
Cardinality	0...1
Type	CodeableConcept
Binding	Destination codes Destination (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD

Example instances

encounter
ContactType	CT0005 - Inpatient (code by Healtdata.Be (Sciensano))
ContactWith.HealthProfessional	Reference to HealthProfessional (E. Penninx)
Location	Reference to HealthcareProvide (GRAND HOPITAL DE CHARLEROI - SAINT-JOSEPH)
StartDateTime	2012-08-16
EndDateTime	2012-08-19
ContactReason.Problem
ContactReason.Procedure
ContactReason.DeviatingResult
ContactReason.CommentContactReason	stomach ache
Origin	264362003 - Home (code by SNOMED CT)
Destination	22232009 - Hospital (code by SNOMED CT)

zib Encounter-v4.0.1 difference

Concept	Category	Description
`ContactType`	terminology	Replaced codes with codes in use by Healthdata.be - Sciensano.
`Destination`	terminology	Added SNOMED codes Unkown and Other to the ValueSet.
`Origin`	terminology	Added SNOMED codes Unkown and Other to the ValueSet.

Terminology Bindings

Path	Name	Strength	URL
ContactType	ContactType	extensible	https://fhir.healthdata.be/ValueSet/ContactType
Origin	Origin	extensible	https://fhir.healthdata.be/ValueSet/Origin
Destination	Destination	extensible	https://fhir.healthdata.be/ValueSet/Destination