HdBe-Encounter
Profile | Status | URL |
---|---|---|
HdBe-Encounter | draft | https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Encounter |
encounter | Encounter | ||
contact_type | 1..1 | CodeableConceptBinding | |
contact_with | 0..* | BackboneElement | |
health_professional | 1..1 | Reference(HdBe HealthProfessional) | |
location | 0..1 | BackboneElement | |
healthcare_provider | 1..1 | Reference(HdBe HealthcareProvider) | |
start_date_time | 1..1 | dateTime | |
end_date_time | 0..1 | dateTime | |
contact_reason | 0..* | BackboneElement | |
problem | 0..* | Reference(HdBe Problem) | |
procedure | 0..* | Reference(HdBe Procedure) | |
deviating_result | 0..* | string | |
comment_contact_reason | 0..1 | string | |
origin | 0..1 | CodeableConceptBinding | |
destination | 0..1 | CodeableConceptBinding |
encounter | 0..* | |
encounter.contact_type | CodeableConcept | 1..1 |
encounter.contact_with | BackboneElement | 0..* |
encounter.contact_with.health_professional | Reference(HdBe HealthProfessional) | 1..1 |
encounter.location | BackboneElement | 0..1 |
encounter.location.healthcare_provider | Reference(HdBe HealthcareProvider) | 1..1 |
encounter.start_date_time | dateTime | 1..1 |
encounter.end_date_time | dateTime | 0..1 |
encounter.contact_reason | BackboneElement | 0..* |
encounter.contact_reason.problem | Reference(HdBe Problem) | 0..* |
encounter.contact_reason.procedure | Reference(HdBe Procedure) | 0..* |
encounter.contact_reason.deviating_result | string | 0..* |
encounter.contact_reason.comment_contact_reason | 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 |
|
Mappings |
|
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 |
|
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 |
|
Mappings |
|
encounter.contact_type | |
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 |
|
Mappings |
|
encounter.contact_with | |
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 | BackboneElement |
Invariants |
|
Mappings |
|
encounter.contact_with.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 |
|
encounter.contact_with.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 |
|
Mappings |
|
encounter.contact_with.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 |
|
Mappings |
|
encounter.contact_with.health_professional | |
Definition | Root concept of the HealthProfessional information model. This root concept contains all data elements of the HealthProfessional information model. When referring to this information model the role the health professional fulfils in the healthcare process can be addressed additionally. For health professionals, this could be for example main practitioner or referrer. |
Cardinality | 1...1 |
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 |
|
Mappings |
|
encounter.location | |
Definition | The physical location at which the contact took or will take place. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
encounter.location.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 |
|
encounter.location.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 |
|
Mappings |
|
encounter.location.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 |
|
Mappings |
|
encounter.location.healthcare_provider | |
Definition | Root concept of the Healthcare Provider information model. This root concept contains all data elements of the Healthcare Provider information model. |
Cardinality | 1...1 |
Type | Reference(HdBe HealthcareProvider) |
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 |
|
Mappings |
|
encounter.start_date_time | |
Definition | The date and time at which the contact took or will take place. |
Cardinality | 1...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
encounter.end_date_time | |
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 |
|
Mappings |
|
encounter.contact_reason | |
Definition | Container of the ContactReason concept. This container contains all data elements of the ContactReason concept. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
encounter.contact_reason.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 |
|
encounter.contact_reason.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 |
|
Mappings |
|
encounter.contact_reason.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 |
|
Mappings |
|
encounter.contact_reason.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 |
|
Mappings |
|
encounter.contact_reason.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 |
|
Mappings |
|
encounter.contact_reason.deviating_result | |
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 |
|
Mappings |
|
encounter.contact_reason.comment_contact_reason | |
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 |
|
Mappings |
|
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 Herkomst (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 |
|
Mappings |
|
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 Bestemming (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 |
|
Mappings |
|
Example instances
[CBB name] | |
---|---|
[Concept name ] | [example value] |
// example of NameInformation
## Example instances
| name_information | |
|----------------------|-------------------|
| first_names | Johanna Petronella Maria
| initials | J.P.M.
| given_name | Jo
| name_usage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| last_name.prefix | van
| last_name.last_name | Putten
| last_name_partner.partner_prefix | van der
| last_name_partner.partner_last_name | Giessen
| titles |
zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference
Concept | Category | Description |
---|---|---|
[element.path] |
[category of change] | [Description of change]([Reference to ticket/issue/zulip chat using MarkDown link]) |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
contact_type | ContactType | extensible | https://fhir.healthdata.be/ValueSet/ContactType |
origin | Herkomst | extensible | https://fhir.healthdata.be/ValueSet/Herkomst |
destination | Bestemming | extensible | https://fhir.healthdata.be/ValueSet/Bestemming |