Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build NL

Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: KT2_Practitioner

Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2Practitioner Version: 0.15.0
Draft as of 2023-01-24 Realm: Netherlands flag Computable Name: KT2_Practitioner

Copyright/Legal: VZVZ

The Practitioner resource represents a healthcare professional who is directly or indirectly involved in the provision of patient care. This includes physicians, nurses, therapists, and other healthcare providers operating within the Koppeltaal ecosystem. The profile extends the NlcoreHealthProfessionalPractitioner profile, implementing Dutch Health Information Building Block (zib) standards.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* NlcoreHealthProfessionalPractitioner HealthProfessional
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:big Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/big
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:uzi Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:agb Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
... Slices for name ΣC 1..* HumanName NameInformation
Slice: Unordered, Open by value:use
Constraints: kt2pnu-1
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 1..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
..... given ΣC 1..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given Σ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... system ΣC 1..1 code TelecomType
Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
...... Slices for extension Content/Rules for all slices
....... extension:telecomType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
..... use ?!Σ 0..1 code NumberType
Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 1..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system ΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation-GivenName.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.telecom:telephoneNumbers.systemrequiredContactInformationTelephoneNumbersSystem
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem
Practitioner.telecom:telephoneNumbers.userequiredContactInformationTelephoneNumbersUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse
Practitioner.telecom:emailAddresses.systemrequiredPattern Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Practitioner.telecom:emailAddresses.userequiredContactInformationEmailAddressesUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitioner.telecom:telephoneNumbers, Practitioner.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()
nl-core-NameInformation-01warningPractitioner.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPractitioner.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1errorPractitioner.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPractitioner.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcoreHealthProfessionalPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner NlcoreHealthProfessionalPractitioner
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... identifier 1..* Identifier HealthProfessionalIdentificationNumber
... active 1..1 boolean Whether this practitioner's record is in active use
... Slices for name Content/Rules for all slices
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 AssemblyOrder(5.2.0) Preferred display order of name parts
..... text 0..1 string Text representation of the full name
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string FirstName / Initial
..... prefix 0..* string Titles
..... suffix 0..* string Titles
..... period 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... text 0..1 string Text representation of the full name
..... period 0..1 Period Time period when name was/is in use
... telecom 1..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment 0..1 ExtComment Optional Extensions Element
..... use 0..1 code NumberType
..... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses 1..* NlcoreContactInformationEmailAddresses EmailAddresses
..... use 0..1 code EmailAddressType
..... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period 0..1 Period Time period when the contact point was/is in use
... address 0..0
... photo 0..0
... qualification 0..0
... communication 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* NlcoreHealthProfessionalPractitioner HealthProfessional
... id Σ 0..1 id 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier HealthProfessionalIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:big Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/big
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:uzi Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:agb Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
... Slices for name ΣC 1..* HumanName NameInformation
Slice: Unordered, Open by value:use
Constraints: kt2pnu-1
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 1..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given ΣC 1..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given Σ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:comment 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system ΣC 1..1 code TelecomType
Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:telecomType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (required)
...... value 0..1 string Primitive value for code
..... value Σ 0..1 string TelephoneNumber
..... use ?!Σ 0..1 code NumberType
Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 1..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... 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 ΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value Σ 0..1 string EmailAddress
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. This ConceptMap is based on GeslachtCodelijst as defined in the zib Patient to avoid duplication of ConceptMaps. The GeslachtCodelijst of Patient and HealthProfessional are identical in terms of codes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:genderCodelist 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (required)
.... value 0..1 string Primitive value for code
... birthDate Σ 0..1 date The date on which the practitioner was born

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation-GivenName.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.telecom:telephoneNumbers.systemrequiredContactInformationTelephoneNumbersSystem
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem
Practitioner.telecom:telephoneNumbers.system.extension:telecomType.value[x]requiredTelecomTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000
Practitioner.telecom:telephoneNumbers.userequiredContactInformationTelephoneNumbersUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse
Practitioner.telecom:emailAddresses.systemrequiredPattern Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Practitioner.telecom:emailAddresses.userequiredContactInformationEmailAddressesUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Practitioner.gender.extension:genderCodelist.value[x]requiredGeslachtCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.8--20200901000000
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitioner.telecom:telephoneNumbers, Practitioner.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()
nl-core-NameInformation-01warningPractitioner.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPractitioner.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1errorPractitioner.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPractitioner.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcoreHealthProfessionalPractitioner

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* NlcoreHealthProfessionalPractitioner HealthProfessional
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:big Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/big
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:uzi Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:agb Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
... Slices for name ΣC 1..* HumanName NameInformation
Slice: Unordered, Open by value:use
Constraints: kt2pnu-1
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 1..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
..... given ΣC 1..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given Σ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... system ΣC 1..1 code TelecomType
Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
...... Slices for extension Content/Rules for all slices
....... extension:telecomType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
..... use ?!Σ 0..1 code NumberType
Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 1..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system ΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation-GivenName.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.telecom:telephoneNumbers.systemrequiredContactInformationTelephoneNumbersSystem
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem
Practitioner.telecom:telephoneNumbers.userequiredContactInformationTelephoneNumbersUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse
Practitioner.telecom:emailAddresses.systemrequiredPattern Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Practitioner.telecom:emailAddresses.userequiredContactInformationEmailAddressesUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitioner.telecom:telephoneNumbers, Practitioner.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()
nl-core-NameInformation-01warningPractitioner.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPractitioner.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1errorPractitioner.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPractitioner.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Differential View

This structure is derived from NlcoreHealthProfessionalPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner NlcoreHealthProfessionalPractitioner
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... identifier 1..* Identifier HealthProfessionalIdentificationNumber
... active 1..1 boolean Whether this practitioner's record is in active use
... Slices for name Content/Rules for all slices
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 AssemblyOrder(5.2.0) Preferred display order of name parts
..... text 0..1 string Text representation of the full name
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string FirstName / Initial
..... prefix 0..* string Titles
..... suffix 0..* string Titles
..... period 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... text 0..1 string Text representation of the full name
..... period 0..1 Period Time period when name was/is in use
... telecom 1..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment 0..1 ExtComment Optional Extensions Element
..... use 0..1 code NumberType
..... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses 1..* NlcoreContactInformationEmailAddresses EmailAddresses
..... use 0..1 code EmailAddressType
..... rank 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period 0..1 Period Time period when the contact point was/is in use
... address 0..0
... photo 0..0
... qualification 0..0
... communication 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* NlcoreHealthProfessionalPractitioner HealthProfessional
... id Σ 0..1 id 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier HealthProfessionalIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:big Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/big
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:uzi Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:agb Σ 0..* Identifier An identifier for the person as this agent

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
... Slices for name ΣC 1..* HumanName NameInformation
Slice: Unordered, Open by value:use
Constraints: kt2pnu-1
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 1..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given ΣC 1..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given Σ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:comment 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system ΣC 1..1 code TelecomType
Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:telecomType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (required)
...... value 0..1 string Primitive value for code
..... value Σ 0..1 string TelephoneNumber
..... use ?!Σ 0..1 code NumberType
Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 1..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... 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 ΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value Σ 0..1 string EmailAddress
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. This ConceptMap is based on GeslachtCodelijst as defined in the zib Patient to avoid duplication of ConceptMaps. The GeslachtCodelijst of Patient and HealthProfessional are identical in terms of codes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:genderCodelist 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (required)
.... value 0..1 string Primitive value for code
... birthDate Σ 0..1 date The date on which the practitioner was born

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.name:nameInformation-GivenName.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Practitioner.telecom:telephoneNumbers.systemrequiredContactInformationTelephoneNumbersSystem
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem
Practitioner.telecom:telephoneNumbers.system.extension:telecomType.value[x]requiredTelecomTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000
Practitioner.telecom:telephoneNumbers.userequiredContactInformationTelephoneNumbersUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse
Practitioner.telecom:emailAddresses.systemrequiredPattern Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Practitioner.telecom:emailAddresses.userequiredContactInformationEmailAddressesUse
http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Practitioner.gender.extension:genderCodelist.value[x]requiredGeslachtCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.8--20200901000000
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitioner.telecom:telephoneNumbers, Practitioner.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
kt2pnu-1errorPractitioner.namePractitioner name use must not be empty
: use.hasValue()
nl-core-NameInformation-01warningPractitioner.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPractitioner.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1errorPractitioner.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPractitioner.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcoreHealthProfessionalPractitioner

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Identifier

The identifier element is mandatory and should contain at least one identifier for the practitioner. Common identifiers include:

  • UZI (Unieke Zorgverlener Identificatie) number
  • AGB (Algemeen GegevensBeheer) code
  • BIG (Beroepen in de Individuele Gezondheidszorg) registration number
  • Internal practitioner identifiers

Example:

{
  "identifier": [{
    "system": "http://fhir.nl/fhir/NamingSystem/uzi-nr-pers",
    "value": "12345678"
  }]
}

Active

The active element is required and indicates whether the practitioner's record is in active use.

Values:

  • true - Practitioner is active
  • false - Practitioner is no longer active

Name

The name element is mandatory and follows Dutch naming conventions. At least one name must be provided with:

  • A required family element
  • At least one given element

The profile includes specific slices for Dutch name information:

  • nameInformation - Official names according to Dutch conventions
  • nameInformation-GivenName - Usual/calling names

Important constraints:

  • The profile includes the constraint kt2pnu-1 on names
  • Various extensions like nameUsage are marked as not used in KT2
  • The text, prefix, suffix, and period elements are not used in the nameInformation slice

Example:

{
  "name": [{
    "use": "official",
    "family": "Jansen",
    "given": ["Peter", "J."]
  }]
}

Telecom

The profile requires at least one email address in the telecom[emailAddresses] slice.

Example:

{
  "telecom": [{
    "system": "email",
    "value": "p.jansen@example.org"
  }]
}

For telephone numbers (telecom[telephoneNumbers]), the following elements are not used:

  • extension[comment]
  • use
  • rank
  • period

Elements Not Used

The following elements are explicitly excluded in this profile:

  • address - Practitioner addresses are not used
  • photo - Practitioner photos are not used

Usage Notes

  • This profile strictly follows Dutch healthcare naming and identification standards
  • Email contact is mandatory for all practitioners
  • The profile is designed to work within the Dutch healthcare context while maintaining FHIR compatibility