Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile:

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner
Version:1.2.2
Name:BePractitioner
Status:Active as of 2021-07-10T14:45:27+02:00
Definition:

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

Publisher:eHealth
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from Practitioner

Summary

Mandatory: 1 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 Practitioner.identifier is sliced based on the value of value:system

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... Slices for identifier S0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether this practitioner's record is in active use
... name 1..*HumanNameThe name(s) associated with the practitioner
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender 0..1codemale | female | other | unknown
... communication 0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:NIHDI Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSIN Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CBE Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.



doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... Slices for identifier Σ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:system

doco Documentation for this format

This structure is derived from Practitioner

Summary

Mandatory: 1 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 Practitioner.identifier is sliced based on the value of value:system

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... Slices for identifier S0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierAn identifier for the person as this agent
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether this practitioner's record is in active use
... name 1..*HumanNameThe name(s) associated with the practitioner
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender 0..1codemale | female | other | unknown
... communication 0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:NIHDI Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSIN Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CBE Σ0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.



doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier:NIHDI.userequiredIdentifierUse
Practitioner.identifier:NIHDI.typeextensibleIdentifier Type Codes
Practitioner.identifier:SSIN.userequiredIdentifierUse
Practitioner.identifier:SSIN.typeextensibleIdentifier Type Codes
Practitioner.identifier:CBE.userequiredIdentifierUse
Practitioner.identifier:CBE.typeextensibleIdentifier Type Codes
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
dom-2PractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4PractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5PractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1Practitioner.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:NIHDI.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:NIHDI.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NIHDI.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSINAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:SSIN.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:SSIN.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:SSIN.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBEAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:CBE.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:CBE.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:CBE.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())