HdBe-HealthProfessional
| Profile | Description | Status | URL |
|---|---|---|---|
| HdBe-HealthProfessional-Practitioner | A health professional is a person who is authorized to perform actions in the field of individual healthcare. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-Practitioner |
| HdBe-HealthProfessional-PractitionerRole | The types of services and locations that a health professionals are able to provide for a HealthcareOrganization. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole |
HdBe-HealthProfessional-Practitioner
| Instructions |
|---|
HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (HdBe-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the |
| Practitioner | I | Practitioner | Element IdPractitioner HealthProfessional Alternate namesZorgverlener DefinitionA health professional is a person who is authorized to perform actions in the field of individual healthcare. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (HdBe-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | Element IdPractitioner.identifier HealthProfessionalIdentificationNumber Alternate namesZorgverlenerIdentificatienummer DefinitionThe healthcare provider identification number is a number that uniquely identifies the healthcare provider. A health professional has a NIHDI number (National Institute for Health and Disability Insurance). A local identifier can also be provided when this is desired. Often, specific identities are assigned for the agent. Unordered, Open, by $this(Value) Constraints
|
| NIDHI | Σ | 0..* | Identifier | Element IdPractitioner.identifier:NIDHI An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
{
"system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi"
}
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
|
| name | Σ | 0..* | HumanName | Element IdPractitioner.name NameInformation Alternate namesNaamgegevens DefinitionHealth professional’s full name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
Unordered, Open, by use(Value) Constraints
|
| nameInformation | Σ I | 0..2 | HdBe NameInformation | Element IdPractitioner.name:nameInformation NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
|
| nameInformation-GivenName | Σ | 0..* | HdBe NameInformation.GivenName | Element IdPractitioner.name:nameInformation-GivenName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR. HdBe NameInformation.GivenName Constraints
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitioner.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es). Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
| address | Σ | 0..* | HdBe AddressInformation | Element IdPractitioner.address AddressInformation Alternate namesAdresgegevens DefinitionHealth professional’s address information. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| gender | Σ | 0..1 | codeBinding | Element IdPractitioner.gender Gender Alternate namesGeslacht DefinitionHealth professional’s administrative gender - the gender that the health professional is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'Gender-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'. AdministrativeGender (required)Permitted Values Gender_to_AdministrativeGender Constraints
|
| extension | I | 0..* | Extension | Element IdPractitioner.gender.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) Constraints
|
| gender | I | 0..* | Extension(CodeableConcept) | Element IdPractitioner.gender.extension:gender 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-CodeSpecification Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPractitioner.gender.extension:gender.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. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
| value[x] | 0..1 | Binding | Element IdPractitioner.gender.extension:gender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
| |
| identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
| code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
| period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. 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.
|
| issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. 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.
|
| communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. CommonLanguages (preferred)Constraints
|
| Practitioner | I | Practitioner | Element IdPractitioner HealthProfessional Alternate namesZorgverlener DefinitionA health professional is a person who is authorized to perform actions in the field of individual healthcare. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (HdBe-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | Element IdPractitioner.identifier HealthProfessionalIdentificationNumber Alternate namesZorgverlenerIdentificatienummer DefinitionThe healthcare provider identification number is a number that uniquely identifies the healthcare provider. A health professional has a NIHDI number (National Institute for Health and Disability Insurance). A local identifier can also be provided when this is desired. Often, specific identities are assigned for the agent. Unordered, Open, by $this(Value) Constraints
|
| NIDHI | Σ | 0..* | Identifier | Element IdPractitioner.identifier:NIDHI An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
{
"system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi"
}
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
|
| name | Σ | 0..* | HumanName | Element IdPractitioner.name NameInformation Alternate namesNaamgegevens DefinitionHealth professional’s full name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
Unordered, Open, by use(Value) Constraints
|
| nameInformation | Σ I | 0..2 | HdBe NameInformation | Element IdPractitioner.name:nameInformation NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
|
| nameInformation-GivenName | Σ | 0..* | HdBe NameInformation.GivenName | Element IdPractitioner.name:nameInformation-GivenName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR. HdBe NameInformation.GivenName Constraints
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitioner.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es). Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
| address | Σ | 0..* | HdBe AddressInformation | Element IdPractitioner.address AddressInformation Alternate namesAdresgegevens DefinitionHealth professional’s address information. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| gender | Σ | 0..1 | codeBinding | Element IdPractitioner.gender Gender Alternate namesGeslacht DefinitionHealth professional’s administrative gender - the gender that the health professional is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'Gender-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'. AdministrativeGender (required)Permitted Values Gender_to_AdministrativeGender Constraints
|
| extension | I | 0..* | Extension | Element IdPractitioner.gender.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) Constraints
|
| gender | I | 0..* | Extension(CodeableConcept) | Element IdPractitioner.gender.extension:gender 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-CodeSpecification Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPractitioner.gender.extension:gender.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. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
| value[x] | 0..1 | Binding | Element IdPractitioner.gender.extension:gender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
| |
| identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
| code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
| period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. 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.
|
| issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. 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.
|
| communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. CommonLanguages (preferred)Constraints
|
| Practitioner | I | Practitioner | Element IdPractitioner HealthProfessional Alternate namesZorgverlener DefinitionA health professional is a person who is authorized to perform actions in the field of individual healthcare. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (HdBe-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | Element IdPractitioner.identifier HealthProfessionalIdentificationNumber Alternate namesZorgverlenerIdentificatienummer DefinitionThe healthcare provider identification number is a number that uniquely identifies the healthcare provider. A health professional has a NIHDI number (National Institute for Health and Disability Insurance). A local identifier can also be provided when this is desired. Often, specific identities are assigned for the agent. Unordered, Open, by $this(Value) Constraints
|
| NIDHI | Σ | 0..* | Identifier | Element IdPractitioner.identifier:NIDHI An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
{
"system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi"
}
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
|
| name | Σ | 0..* | HumanName | Element IdPractitioner.name NameInformation Alternate namesNaamgegevens DefinitionHealth professional’s full name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
Unordered, Open, by use(Value) Constraints
|
| nameInformation | Σ I | 0..2 | HdBe NameInformation | Element IdPractitioner.name:nameInformation NameInformation Alternate namesNaamgegevens DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the CBB is mapped to FHIR.
|
| nameInformation-GivenName | Σ | 0..* | HdBe NameInformation.GivenName | Element IdPractitioner.name:nameInformation-GivenName Name of a human - parts and usage DefinitionThis slice represents the name information normally used to address the person. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the CBB is mapped to FHIR. HdBe NameInformation.GivenName Constraints
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitioner.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es). Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
| address | Σ | 0..* | HdBe AddressInformation | Element IdPractitioner.address AddressInformation Alternate namesAdresgegevens DefinitionHealth professional’s address information. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| gender | Σ | 0..1 | codeBinding | Element IdPractitioner.gender Gender Alternate namesGeslacht DefinitionHealth professional’s administrative gender - the gender that the health professional is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap 'Gender-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'. AdministrativeGender (required)Permitted Values Gender_to_AdministrativeGender Constraints
|
| extension | I | 0..* | Extension | Element IdPractitioner.gender.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) Constraints
|
| gender | I | 0..* | Extension(CodeableConcept) | Element IdPractitioner.gender.extension:gender 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-CodeSpecification Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPractitioner.gender.extension:gender.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. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
| value[x] | 0..1 | Binding | Element IdPractitioner.gender.extension:gender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
| |
| identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
| code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
| period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. 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.
|
| issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. 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.
|
| communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. CommonLanguages (preferred)Constraints
|
Mapping FHIR profile to CBB
| Path | map | CBB |
|---|---|---|
| Practitioner | HealthProfessional | HdBe-HealthProfessional |
| Practitioner.identifier | HealthProfessional.HealthProfessionalIdentificationNumber | HdBe-HealthProfessional |
| Practitioner.name | HealthProfessional.NameInformation | HdBe-HealthProfessional |
| Practitioner.telecom | HealthProfessional.ContactInformation | HdBe-HealthProfessional |
| Practitioner.address | HealthProfessional.AddressInformation | HdBe-HealthProfessional |
| Practitioner.gender | HealthProfessional.Gender | HdBe-HealthProfessional |
| Practitioner.gender.extension:gender.value[x] | HealthProfessional.Gender | HdBe-HealthProfessional |
zib HealthProfessional-Practitioner difference
| Concept | Category | Description |
|---|---|---|
identifier |
slicing | Removed AGB, BIG and UZI slices and added NIDHI slice. |
name |
textual | Removed Dutch specific context. |
telecom |
reference | Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles. |
telecom |
slicing | Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary. |
gender |
textual | Corrected incorrect definition (zib ticket 1368) and added additional remark that the gender is an administrative gender. |
gender.extension.value[x] |
mapping | Added mapping to gender for both the zib and the logical model. |
HdBe-HealthProfessional-PractitionerRole
| Instructions |
|---|
HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (HdBe-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the |
| PractitionerRole | I | PractitionerRole | Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (HdBe-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. 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.
|
| practitioner | Σ I | 0..1 | Reference(Practitioner | HdBe HealthProfessional Practitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionPractitioner that is able to provide the defined services for the organization. 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. Reference(Practitioner | HdBe HealthProfessional Practitioner) Constraints
|
| organization | Σ I | 0..1 | Reference(Organization | HdBe HealthcareOrganization Organization) | Element IdPractitionerRole.organization HealthcareOrganization Alternate namesZorgaanbieder DefinitionThe organization the health professional works for. A HealthcareOrganization in CBB terms is primarily a location where care is provided, and so the CBB concept HealthcareOrganization (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile HdBe-HealthcareOrganization). However, this particular context refers to the organizational aspects of a HealthcareOrganization rather than its physical location. Therefore, this concept is fulfilled using a reference to the Organization resource (profile HdBe-HealthcareOrganization-Organization) and mapped onto Reference(Organization | HdBe HealthcareOrganization Organization) Constraints
|
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionRoles which this practitioner is authorized to perform for the organization. Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
|
| specialty | Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionSpecific specialty of the practitioner. 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. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
|
| location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe location(s) at which this practitioner provides care. 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.
|
| healthcareService | I | 0..* | Reference(HealthcareService) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). 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.
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitionerRole.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es) that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. 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.
|
| availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
| daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
| allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
| availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| |
| description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. 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.
|
| availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. 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.
|
| PractitionerRole | I | PractitionerRole | Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (HdBe-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. 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.
|
| practitioner | Σ I | 0..1 | Reference(Practitioner | HdBe HealthProfessional Practitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionPractitioner that is able to provide the defined services for the organization. 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. Reference(Practitioner | HdBe HealthProfessional Practitioner) Constraints
|
| organization | Σ I | 0..1 | Reference(Organization | HdBe HealthcareOrganization Organization) | Element IdPractitionerRole.organization HealthcareOrganization Alternate namesZorgaanbieder DefinitionThe organization the health professional works for. A HealthcareOrganization in CBB terms is primarily a location where care is provided, and so the CBB concept HealthcareOrganization (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile HdBe-HealthcareOrganization). However, this particular context refers to the organizational aspects of a HealthcareOrganization rather than its physical location. Therefore, this concept is fulfilled using a reference to the Organization resource (profile HdBe-HealthcareOrganization-Organization) and mapped onto Reference(Organization | HdBe HealthcareOrganization Organization) Constraints
|
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionRoles which this practitioner is authorized to perform for the organization. Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
|
| specialty | Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionSpecific specialty of the practitioner. 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. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
|
| location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe location(s) at which this practitioner provides care. 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.
|
| healthcareService | I | 0..* | Reference(HealthcareService) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). 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.
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitionerRole.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es) that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. 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.
|
| availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
| daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
| allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
| availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| |
| description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. 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.
|
| availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. 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.
|
| PractitionerRole | I | PractitionerRole | Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (HdBe-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareOrganization. The concepts Specialty and HealthcareOrganization are therefore mapped onto PractitionerRole.
Although the concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part as the clinical resource for that specific case, for example in the
| |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. 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.
|
| practitioner | Σ I | 0..1 | Reference(Practitioner | HdBe HealthProfessional Practitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionPractitioner that is able to provide the defined services for the organization. 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. Reference(Practitioner | HdBe HealthProfessional Practitioner) Constraints
|
| organization | Σ I | 0..1 | Reference(Organization | HdBe HealthcareOrganization Organization) | Element IdPractitionerRole.organization HealthcareOrganization Alternate namesZorgaanbieder DefinitionThe organization the health professional works for. A HealthcareOrganization in CBB terms is primarily a location where care is provided, and so the CBB concept HealthcareOrganization (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile HdBe-HealthcareOrganization). However, this particular context refers to the organizational aspects of a HealthcareOrganization rather than its physical location. Therefore, this concept is fulfilled using a reference to the Organization resource (profile HdBe-HealthcareOrganization-Organization) and mapped onto Reference(Organization | HdBe HealthcareOrganization Organization) Constraints
|
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionRoles which this practitioner is authorized to perform for the organization. Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
|
| specialty | Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionSpecific specialty of the practitioner. 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. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
|
| location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe location(s) at which this practitioner provides care. 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.
|
| healthcareService | I | 0..* | Reference(HealthcareService) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). 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.
|
| telecom | Σ I | 0..* | HdBe ContactInformation | Element IdPractitionerRole.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionHealth professional’s telephone number(s) or e-mail address(es) that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. 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.
|
| availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
| daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
| allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
| availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
| notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| |
| description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. 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.
|
| availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. 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.
|
Mapping FHIR profile to CBB
| Path | map | CBB |
|---|---|---|
| PractitionerRole.organization | HealthProfessional.HealthcareOrganization | HdBe-HealthProfessional |
| PractitionerRole.specialty | HealthProfessional.Specialty | HdBe-HealthProfessional |
| PractitionerRole.telecom | HealthProfessional.ContactInformation | HdBe-HealthProfessional |
zib HealthProfessional-PractitionerRole difference
| Concept | Category | Description |
|---|---|---|
| description | textual | Aligned StructureDefinition.description with the PractitionerRole resource. |
organization |
textual | Removed Dutch context and argumentation for the chosen reference to HealthcareOrganization-Organization rather than HealthcareOrganization to avoid confusion. |
specialty |
slicing | Removed Dutch specialty slice. |
specialty |
terminology | Replaced zib ValueSet with FHIR core ValueSet for specialty. |
telecom |
reference | Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles. |
telecom |
slicing | Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary. |
Terminology Bindings
| Path | Name | Strength | URL | ConceptMap |
|---|---|---|---|---|
| Practitioner.gender | administrative-gender|4.0.1 | required | http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 | https://fhir.healthdata.be/ConceptMap/Gender-to-AdministrativeGender |
| Practitioner.gender.extension.value[x] | Gender | required | https://fhir.healthdata.be/ValueSet/Gender | No bound ConceptMap |