Important: This is a draft IG for trial use. Click here to give feedback.

EN NL FR

HdBe-Encounter

CBBDescriptionStatus
HdBe-Encounter

A contact is any interaction, regardless of the situation, between a patient and the healthcare professional, in which the healthcare professional has primary responsibility for diagnosing, evaluating and treating the patient’s condition and informing the patient. These can be visits, appointments or non face-to-face interactions.

Contacts can be visits to the general practitioner or other practices, home visits, admissions (in hospitals, nursing homes or care homes, psychiatric institutions or convalescent homes) or other relevant contacts. This includes past and future contacts.

Purpose

Contacts can be recorded to provide insight on the interactions that have taken place between the patient and healthcare professional and in which context these took place.

Instructions

The home environment is the environment where the patient stays regular. This distinguishes between living in a private home and living in an institution for nursing and care. This distinction is the difference between "independent living with any additional care" and "being taken care of including living". Thus, residential homes are counted as the first and stay in a nursing home to the second.

active

id0..1string
extensionI0..*Extension
ContactType1..1CodeableConceptBinding
ContactWithI0..*Reference(HdBe-HealthProfessional)
LocationI0..1Reference(HdBe-HealthcareOrganization)
StartDateTime1..1dateTime
EndDateTime0..1dateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
ProblemI0..*Reference(HdBe-Problem)
ProcedureI0..*Reference(HdBe-Procedure)
DeviatingResult0..*string
CommentContactReason0..1string
Origin0..1CodeableConceptBinding
Destination0..1CodeableConceptBinding

Encounter0..*
Encounter.ContactTypeCodeableConcept1..1
Encounter.ContactWithReference(HdBe-HealthProfessional)0..*
Encounter.LocationReference(HdBe-HealthcareOrganization)0..1
Encounter.StartDateTimedateTime1..1
Encounter.EndDateTimedateTime0..1
Encounter.ContactReasonBackboneElement0..*
Encounter.ContactReason.ProblemReference(HdBe-Problem)0..*
Encounter.ContactReason.ProcedureReference(HdBe-Procedure)0..*
Encounter.ContactReason.DeviatingResultstring0..*
Encounter.ContactReason.CommentContactReasonstring0..1
Encounter.OriginCodeableConcept0..1
Encounter.DestinationCodeableConcept0..1


Encounter
DefinitionRoot concept of the Contact information model. This concept contains all data elements of the Contact information model.
Cardinality0...*
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Encounter.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Encounter.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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
DefinitionThe type of contact, such as ambulatory, home visit, or virtual.
Cardinality1...1
TypeCodeableConcept
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
DefinitionThe 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.
Cardinality0...*
TypeReference(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
DefinitionThe physical location at which the contact took or will take place.
Cardinality0...1
TypeReference(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
DefinitionThe date and time at which the contact took or will take place.
Cardinality1...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Encounter.EndDateTime
DefinitionThe 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.
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Encounter.ContactReason
DefinitionContainer of the ContactReason concept. This container contains all data elements of the ContactReason concept.
Cardinality0...*
TypeBackboneElement
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
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Encounter.ContactReason.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
DefinitionThe problem that is the reason for the contact.
Cardinality0...*
TypeReference(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
DefinitionThe procedure carried out or that will be carried out during the contact.
Cardinality0...*
TypeReference(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
DefinitionA deviating result which serves as the reason for the contact.
Cardinality0...*
Typestring
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
DefinitionExplanation of the reason for the contact.
Cardinality0...1
Typestring
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
DefinitionLocation from which the patient comes before the encounter. In most cases this will only be used when the patient is admitted.
Cardinality0...1
TypeCodeableConcept
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
DefinitionLocation to which the patient will go after the encounter. In most cases this will only be used when the patient is discharged.
Cardinality0...1
TypeCodeableConcept
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 Reference to HealthProfessional (E. Penninx)
Location Reference to HealthcareProvider (GRAND HOPITAL DE CHARLEROI - SAINT-JOSEPH)
StartDateTime 2012-08-16T08:30:00
EndDateTime 2012-08-19T10:20:00
ContactReason -
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.
ContactType textual Added ', such as ambulatory, home visit, or virtual'
CommentContactReason textual Added period at the end of definition.
Procedure textual Replaced 'or will' by 'or that will'.
Encounter textual Removed Dutch context from Evidence Base and Instructions.



Terminology Bindings

PathNameStrengthURL
ContactTypeContactTypeextensiblehttps://fhir.healthdata.be/ValueSet/ContactType
OriginOriginextensiblehttps://fhir.healthdata.be/ValueSet/Origin
DestinationDestinationextensiblehttps://fhir.healthdata.be/ValueSet/Destination