eHealth Platform Federal Core Profiles
2.0.1 - STU1
This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.0.1: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole | Version: 2.0.1 | |||
Active as of 2022-09-13 | Responsible: eHealth Platform | Realm: BE | Computable Name: BePractitionerRole |
Belgian federal profile for a practitioner role. Initially based on the functional description of the NIHDI.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
practitioner | 0..1 | Reference(BePractitioner) | Practitioner that is able to provide the defined services for the organization | |
organization | 0..1 | Reference(BeOrganization) | Organization where the roles are available | |
Slices for code | S | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system |
code:CD-HCPARTY | 0..* | CodeableConcept | Roles which this practitioner may perform | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | |
code | 1..1 | code | Symbol in syntax defined by the system | |
code:SNOMED-CT | 0..* | CodeableConcept | Roles which this practitioner may perform | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Slices for specialty | 0..* | CodeableConcept | Specific specialty of the practitioner Slice: Unordered, Open by value:coding.system | |
specialty:SNOMED-CT | 0..* | CodeableConcept | Specific specialty of the practitioner | |
coding | 0..* | Coding | Code defined by a terminology system Binding: PracticeSettingCodeValueSet (preferred): base resource valueset | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
practitioner | Σ | 0..1 | Reference(BePractitioner) | Practitioner that is able to provide the defined services for the organization | ||||
organization | Σ | 0..1 | Reference(BeOrganization) | Organization where the roles are available | ||||
Slices for code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
code:CD-HCPARTY | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code:SNOMED-CT | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Slice: Unordered, Open by value:coding.system Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
specialty:SNOMED-CT | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: PracticeSettingCodeValueSet (preferred): base resource valueset | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization. |
Documentation for this format |
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
practitioner | 0..1 | Reference(BePractitioner) | Practitioner that is able to provide the defined services for the organization | |
organization | 0..1 | Reference(BeOrganization) | Organization where the roles are available | |
Slices for code | S | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system |
code:CD-HCPARTY | 0..* | CodeableConcept | Roles which this practitioner may perform | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | |
code | 1..1 | code | Symbol in syntax defined by the system | |
code:SNOMED-CT | 0..* | CodeableConcept | Roles which this practitioner may perform | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Slices for specialty | 0..* | CodeableConcept | Specific specialty of the practitioner Slice: Unordered, Open by value:coding.system | |
specialty:SNOMED-CT | 0..* | CodeableConcept | Specific specialty of the practitioner | |
coding | 0..* | Coding | Code defined by a terminology system Binding: PracticeSettingCodeValueSet (preferred): base resource valueset | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
practitioner | Σ | 0..1 | Reference(BePractitioner) | Practitioner that is able to provide the defined services for the organization | ||||
organization | Σ | 0..1 | Reference(BeOrganization) | Organization where the roles are available | ||||
Slices for code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
code:CD-HCPARTY | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code:SNOMED-CT | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Slice: Unordered, Open by value:coding.system Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
specialty:SNOMED-CT | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Binding: PracticeSettingCodeValueSet (preferred): base resource valueset | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
PractitionerRole.code | example | PractitionerRole |
PractitionerRole.code:CD-HCPARTY | example | PractitionerRole |
PractitionerRole.code:SNOMED-CT | example | PractitionerRole |
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet |
PractitionerRole.specialty:SNOMED-CT | preferred | PracticeSettingCodeValueSet |
PractitionerRole.specialty:SNOMED-CT.coding | preferred | PracticeSettingCodeValueSet |
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |