HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BePractitionerRole

Belgian federal profile for a practitioner role. Initially based on the functional description of the NIHDI.

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerrole

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element (3 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:

  • The element PractitionerRole.code is sliced based on the value of value:coding.system
  • The element PractitionerRole.specialty is sliced based on the value of value:coding.system

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... practitioner 0..1Reference(BePractitioner)Practitioner that is able to provide the defined services for the organization
... organization 0..1Reference(BeOrganization)Organization where the roles are available
... code S0..*(Slice Definition)Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:CD-HCPARTY 0..*CodeableConceptRoles which this practitioner may perform
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... code 1..1codeSymbol in syntax defined by the system
.... code:SNOMED-CT 0..*CodeableConceptRoles which this practitioner may perform
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system
.... specialty:SNOMED-CT 0..*CodeableConceptSpecific specialty of the practitioner
..... coding 0..*CodingCode defined by a terminology system
Binding: PracticeSettingCodeValueSet (preferred)
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active ΣI0..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner ΣI0..1Reference(BePractitioner)Practitioner that is able to provide the defined services for the organization
... organization ΣI0..1Reference(BeOrganization)Organization where the roles are available
... code SΣI0..*(Slice Definition)Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (example)
.... code:CD-HCPARTY ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... code:SNOMED-CT ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... specialty ΣI0..*(Slice Definition)Specific specialty of the practitioner
Slice: Unordered, Open by value:coding.system
Binding: PracticeSettingCodeValueSet (preferred)
.... specialty:SNOMED-CT ΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
Binding: PracticeSettingCodeValueSet (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... location ΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom ΣI0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element (3 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:

  • The element PractitionerRole.code is sliced based on the value of value:coding.system
  • The element PractitionerRole.specialty is sliced based on the value of value:coding.system

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... practitioner 0..1Reference(BePractitioner)Practitioner that is able to provide the defined services for the organization
... organization 0..1Reference(BeOrganization)Organization where the roles are available
... code S0..*(Slice Definition)Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:CD-HCPARTY 0..*CodeableConceptRoles which this practitioner may perform
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... code 1..1codeSymbol in syntax defined by the system
.... code:SNOMED-CT 0..*CodeableConceptRoles which this practitioner may perform
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system
.... specialty:SNOMED-CT 0..*CodeableConceptSpecific specialty of the practitioner
..... coding 0..*CodingCode defined by a terminology system
Binding: PracticeSettingCodeValueSet (preferred)
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active ΣI0..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner ΣI0..1Reference(BePractitioner)Practitioner that is able to provide the defined services for the organization
... organization ΣI0..1Reference(BeOrganization)Organization where the roles are available
... code SΣI0..*(Slice Definition)Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (example)
.... code:CD-HCPARTY ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... code:SNOMED-CT ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... specialty ΣI0..*(Slice Definition)Specific specialty of the practitioner
Slice: Unordered, Open by value:coding.system
Binding: PracticeSettingCodeValueSet (preferred)
.... specialty:SNOMED-CT ΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
Binding: PracticeSettingCodeValueSet (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... location ΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom ΣI0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.code:CD-HCPARTYexamplePractitionerRole
PractitionerRole.code:SNOMED-CTexamplePractitionerRole
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
PractitionerRole.specialty:SNOMED-CTpreferredPracticeSettingCodeValueSet
PractitionerRole.specialty:SNOMED-CT.codingpreferredPracticeSettingCodeValueSet
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

Constraints

IdPathDetailsRequirements