HdBe-ContactInformation
Profile | Description | Status | URL |
---|---|---|---|
HdBe-ContactInformation | Contact information that includes a person's telephone numbers. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation |
Instructions |
---|
Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. |
ContactPoint | I | ContactPoint | Element idContactPoint ContactPoint Alternate namesContactpunten DefinitionRoot concept of the ContactInformation partial information model. This root concept contains all data elements of the ContactInformation partial information model. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
comment | I | 0..1 | Extension(string) | Element idContactPoint.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idContactPoint.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element idContactPoint.extension:comment.value[x] Comment Alternate namesToelichting DefinitionExplanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
system | Σ I | 0..1 | codeBinding | Element idContactPoint.system Type Alternate namesType DefinitionThe type of contact information. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 1..1 | string | Element idContactPoint.value Value Alternate namesWaarde DefinitionThe actual contact information details. Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | Element idContactPoint.use Use Alternate namesGebruik DefinitionPurpose or use of the contact information. For example whether it is a private or business telephone number. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idContactPoint.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContactPoint.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
ContactPoint | I | ContactPoint | Element idContactPoint ContactPoint Alternate namesContactpunten DefinitionRoot concept of the ContactInformation partial information model. This root concept contains all data elements of the ContactInformation partial information model. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
comment | I | 0..1 | Extension(string) | Element idContactPoint.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idContactPoint.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element idContactPoint.extension:comment.value[x] Comment Alternate namesToelichting DefinitionExplanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
system | Σ I | 0..1 | codeBinding | Element idContactPoint.system Type Alternate namesType DefinitionThe type of contact information. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 1..1 | string | Element idContactPoint.value Value Alternate namesWaarde DefinitionThe actual contact information details. Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | Element idContactPoint.use Use Alternate namesGebruik DefinitionPurpose or use of the contact information. For example whether it is a private or business telephone number. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idContactPoint.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContactPoint.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
ContactPoint | I | ContactPoint | Element idContactPoint ContactPoint Alternate namesContactpunten DefinitionRoot concept of the ContactInformation partial information model. This root concept contains all data elements of the ContactInformation partial information model. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
comment | I | 0..1 | Extension(string) | Element idContactPoint.extension:comment Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-Comment Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idContactPoint.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idContactPoint.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idContactPoint.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.healthdata.be/StructureDefinition/ext-Comment
| |
value[x] | 0..1 | Element idContactPoint.extension:comment.value[x] Comment Alternate namesToelichting DefinitionExplanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day.
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
system | Σ I | 0..1 | codeBinding | Element idContactPoint.system Type Alternate namesType DefinitionThe type of contact information. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 1..1 | string | Element idContactPoint.value Value Alternate namesWaarde DefinitionThe actual contact information details. Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | Element idContactPoint.use Use Alternate namesGebruik DefinitionPurpose or use of the contact information. For example whether it is a private or business telephone number. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idContactPoint.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idContactPoint.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
ContactPoint | ContactInformation | HdBe-ContactInformation |
ContactPoint.extension:comment.value[x] | ContactInformation.Comment | HdBe-ContactInformation |
ContactPoint.system | ContactInformation.Type | HdBe-ContactInformation |
ContactPoint.value | ContactInformation.Value | HdBe-ContactInformation |
ContactPoint.use | ContactInformation.Use | HdBe-ContactInformation |
HdBe-ContactInformation is a datatype profile and can therefore not have an example of its own. Rather, an example is provided within the example of the HdBe-profile(s) that use this datatype profile.
zib ContactInformation-TelephoneNumbers and ContactInformation-EmailAddresses difference
The HdBe profile implementation of ContactInformation differs significantly from the zib profiles because the two separate profiles are now replaced with one generic profile. This profile is more in line with FHIR and only has the comment extension as an addition.
As a result, all HdBe profiles that use this datatype profile were also adapted by removing the slicing and replacing them with this singular data type profile. Because of the better alignment with FHIR, the ConceptMaps created by Nictiz are also not necessary.
An explanation of complications between the zib and FHIR:
- In the zib, the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts ContactPoint.system and ContactPoint.use respectively. But a mismatch occurs on the concept of mobile phone numbers, where the zib uses the first concept and FHIR the second. For this reason, the ValueSet on ContactPoint.system is too narrow and the zib code will need to be communicated using the codeSpecification extension. This issue is solved by changing the implementation to a closer implementation of the FHIR profile.
- The zib needs three ConceptMaps to correctly map all values to the values to ContactPoint.use and the ContactPoint.system`, but most of the values could map nicely. To replace the ConceptMaps, the used ValueSets are changed and matched with the use in the FHIR profile.
- There was a cardinality mismatch between the zib (0..1) and FHIR (0..*) that refer to this partial model, which was explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. As the containers are removed in this implementation of the CBB, the cardinality for the ContactInformation model was also adapted from 0..1 to 0..*. This matches the cardinality of the profile again.
Concept | Category | Description |
---|---|---|
ContactPoint |
textual | Removed zib context in the comment. |