Advance Care Planning (PZP)
1.0.0-rc1 - trial-use

Advance Care Planning (PZP), published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-R4/ and changes regularly. See the Directory of published versions

## Resource Profile: ACPHealthProfessionalPractitioner - Detailed Descriptions

Draft as of 2025-10-31

Definitions for the ACP-HealthProfessional-Practitioner resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Practitioner
Definition | A health professional is a person who is authorized to perform actions in the field of individual healthcare. A person who is directly or indirectly involved in the provisioning of healthcare.
Short | HealthProfessionalA person with a formal responsibility in the provisioning of healthcare or related services
Comments | The zib HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareProvider. The zib concepts Specialty and HealthcareProvider are therefore mapped onto PractitionerRole. Although the zib concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part of the clinical resource for that specific case, for example in the `Procedure.performer.role` element. This prevents the creation of duplicate HealthProfessional instances for each clinical situation where the HealthProfessional performs a different role in the process.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Zorgverlener, nl-core-HealthProfessional-Practitioner
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If 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-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If 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-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Practitioner.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Practitioner.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Practitioner.identifier
Definition | The healthcare provider identification number is a number that uniquely identifies the healthcare provider. The following numbers are used in the Netherlands: UZI Health Professionals. Identification of health professionals (people) in the Dutch healthcare industry. VEKTIS AGB-Z. Identifies health professionals and healthcare organizations BIG-ID. The ID of the health professional listed in the BIG Register. This information is not readily available for foreign health professionals. An identifier that applies to this person in this role.
Short | HealthProfessionalIdentificationNumberAn identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Alternate Names | ZorgverlenerIdentificatienummer
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Practitioner.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
8. Practitioner.identifier:big
Slice Name | big
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/big" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Practitioner.identifier:uzi
Slice Name | uzi
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/uzi-nr-pers" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Practitioner.identifier:agb
Slice Name | agb
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/agb-z" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Practitioner.name
Definition | Health professional’s full name. If a health professional identification number is entered, it will be the name as listed in UZI, AGB or by the healthcare center. The name(s) associated with the practitioner.
Short | NameInformationThe name(s) associated with the practitioner
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Control | 0..*
Type | HumanName
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | Naamgegevens
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Practitioner.name`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ use
16. Practitioner.name:nameInformation
Slice Name | nameInformation
Definition | This slice represents the person's official name information, including given names, last name and possibly the partner's last name. The name(s) associated with the practitioner.
Short | NameInformationThe name(s) associated with the practitioner
Comments | This `.name` element accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context SHOULD support the extensions as specified in `.given`, `.family` and `.extension:nameUsage`. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that: If 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. If parts of the family name are specified using the extensions in `.family`, the `.family` element SHOULD be populated with the full family name. Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the zib is mapped to FHIR. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Control | 0..2* This element is affected by the following invariants: ele-1
Type | HumanName(nl core NameInformation)
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | Naamgegevens, nl-core-NameInformation
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) zib-NameInformation-1: If 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-2: If 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()`) nl-core-NameInformation-01: If 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()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Practitioner.name:nameInformation.extension:nameUsage
Slice Name | nameUsage
Definition | A code that represents the preferred display order of the components of this human name.
Short | Preferred display order of name parts
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Assembly Order) (Extension Type: code)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Practitioner.name:nameInformation.extension:nameUsage.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Practitioner.name.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Practitioner.name:nameInformation.extension:nameUsage.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-assembly-order`
24. Practitioner.name:nameInformation.extension:nameUsage.value[x]
Definition | This concept indicates the last name or order of last names with which the person is to be addressed. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | NameUsageValue of extension
Control | 10..1
Binding | The codes SHALL be taken from For codes, see HumanNameAssemblyOrder (required to `http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1` ) Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Naamgebruik
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Practitioner.name:nameInformation.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 10..1
Binding | The codes SHALL be taken from NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Pattern Value | `official`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Practitioner.name:nameInformation.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Control | 0..1 This element is affected by the following invariants: nl-core-NameInformation-01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) nl-core-NameInformation-02: If 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()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Practitioner.name:nameInformation.family.extension:prefix
Slice Name | prefix
Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
Short | Voorvoegsel derived from person's own surname
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Own Prefix) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Practitioner.name:nameInformation.family.extension:prefix.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. Practitioner.name:nameInformation.family.extension:prefix.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-own-prefix`
36. Practitioner.name:nameInformation.family.extension:prefix.value[x]
Definition | Prefix to the person’s own last name. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | PrefixValue of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Voorvoegsels
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Practitioner.name:nameInformation.family.extension:lastName
Slice Name | lastName
Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
Short | Portion derived from person's own surname
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Own Name) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Practitioner.name:nameInformation.family.extension:lastName.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. Practitioner.name:nameInformation.family.extension:lastName.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-own-name`
44. Practitioner.name:nameInformation.family.extension:lastName.value[x]
Definition | The person’s official last name Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | LastNameValue of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Achternaam
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Practitioner.name:nameInformation.family.extension:partnerPrefix
Slice Name | partnerPrefix
Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own.
Short | Voorvoegsel derived from person's partner's surname
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Partner Prefix) (Extension Type: string)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. Practitioner.name:nameInformation.family.extension:partnerPrefix.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. Practitioner.name:nameInformation.family.extension:partnerPrefix.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix`
52. Practitioner.name:nameInformation.family.extension:partnerPrefix.value[x]
Definition | Prefix to the partner’s last name. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | PartnerPrefixValue of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | VoorvoegselsPartner
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Practitioner.name:nameInformation.family.extension:partnerLastName
Slice Name | partnerLastName
Definition | The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.
Short | Portion derived from person's partner's surname
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Partner Name) (Extension Type: string)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. Practitioner.name:nameInformation.family.extension:partnerLastName.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
58. Practitioner.name:nameInformation.family.extension:partnerLastName.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-partner-name`
60. Practitioner.name:nameInformation.family.extension:partnerLastName.value[x]
Definition | Partner’s official last name. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | PartnerLastNameValue of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | AchternaamPartner
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Practitioner.name:nameInformation-GivenName
Slice Name | nameInformation-GivenName
Definition | This slice represents the name information normally used to address the person. The name(s) associated with the practitioner.
Short | Name of a human - parts and usageThe name(s) associated with the practitioner
Comments | This `.name` element represents the Dutch given name ("roepnaam") according to the zib NameInformation v1.1 (2020). Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the zib is mapped to FHIR. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Control | 0..* This element is affected by the following invariants: ele-1
Type | HumanName(nl core NameInformation.GivenName)
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | nl-core-NameInformation.GivenName
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Practitioner.name:nameInformation-GivenName.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 10..1
Binding | The codes SHALL be taken from NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Pattern Value | `usual`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Practitioner.name:nameInformation-GivenName.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Practitioner.name:nameInformation-GivenName.given
Definition | The name normally used to address the person. Given name.
Short | GivenNameGiven names (not always 'first'). Includes middle names
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Control | 10..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Alternate Names | first name, middle name, Roepnaam
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Practitioner.name:nameInformation-GivenName.prefix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Short | Parts that come before the name
Control | 0..0*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Practitioner.name:nameInformation-GivenName.suffix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Short | Parts that come after the name
Control | 0..0*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Practitioner.telecom
Definition | Health professional’s telephone number(s) or e-mail address(es). A contact detail for the practitioner, e.g. a telephone number or an email address.
Short | ContactInformationA contact detail for the practitioner (that apply to all roles)
Comments | The cardinality mismatch between the zib (`0..1`) and FHIR (`0..*`) is explained by the containers TelephoneNumbers (`0..*`) and EmailAddresses (`0..*`) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | Contactgegevens
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Practitioner.telecom`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
76. Practitioner.telecom:telephoneNumbers
Slice Name | telephoneNumbers
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail for the practitioner, e.g. a telephone number or an email address.
Short | TelephoneNumbersA contact detail for the practitioner (that apply to all roles)
Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Control | 0..* This element is affected by the following invariants: ele-1
Type | ContactPoint(nl core ContactInformation TelephoneNumbers)
Is Modifier | false
Standard Status | Normative (from Trial Use)
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | Telefoonnummers, nl-core-ContactInformation-TelephoneNumbers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cpt-2: A system is required if a value is provided. (`value.empty() or system.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Practitioner.telecom:emailAddresses
Slice Name | emailAddresses
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail for the practitioner, e.g. a telephone number or an email address.
Short | EmailAddressesA contact detail for the practitioner (that apply to all roles)
Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Control | 0..* This element is affected by the following invariants: ele-1
Type | ContactPoint(nl core ContactInformation EmailAddresses)
Is Modifier | false
Standard Status | Normative (from Trial Use)
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | EmailAdressen, nl-core-ContactInformation-EmailAddresses
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cpt-2: A system is required if a value is provided. (`value.empty() or system.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Practitioner
2. Practitioner.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
4. Practitioner.name
6. Practitioner.name:nameInformation
Slice Name | nameInformation
8. Practitioner.name:nameInformation.family
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
10. Practitioner.name:nameInformation.family.extension:prefix
Slice Name | prefix
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
12. Practitioner.name:nameInformation.family.extension:lastName
Slice Name | lastName
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
14. Practitioner.name:nameInformation-GivenName
Slice Name | nameInformation-GivenName
16. Practitioner.name:nameInformation-GivenName.given
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter

Guidance on how to interpret the contents of this table can be foundhere

0. Practitioner
Definition | A health professional is a person who is authorized to perform actions in the field of individual healthcare.
Short | HealthProfessional
Comments | The zib HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to this Practitioner profile and a profile on PractitionerRole (http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole). The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareProvider. The zib concepts Specialty and HealthcareProvider are therefore mapped onto PractitionerRole. Although the zib concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part of the clinical resource for that specific case, for example in the `Procedure.performer.role` element. This prevents the creation of duplicate HealthProfessional instances for each clinical situation where the HealthProfessional performs a different role in the process.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Zorgverlener, nl-core-HealthProfessional-Practitioner
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If 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-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Practitioner.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Practitioner.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Practitioner.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Practitioner.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Practitioner.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Practitioner.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Practitioner.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Practitioner.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Practitioner.identifier
Definition | The healthcare provider identification number is a number that uniquely identifies the healthcare provider. The following numbers are used in the Netherlands: UZI Health Professionals. Identification of health professionals (people) in the Dutch healthcare industry. VEKTIS AGB-Z. Identifies health professionals and healthcare organizations BIG-ID. The ID of the health professional listed in the BIG Register. This information is not readily available for foreign health professionals.
Short | HealthProfessionalIdentificationNumber
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Alternate Names | ZorgverlenerIdentificatienummer
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Practitioner.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
20. Practitioner.identifier:big
Slice Name | big
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/big" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Practitioner.identifier:uzi
Slice Name | uzi
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/uzi-nr-pers" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Practitioner.identifier:agb
Slice Name | agb
Definition | An identifier that applies to this person in this role.
Short | An identifier for the person as this agent
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | `{ "system" : "http://fhir.nl/fhir/NamingSystem/agb-z" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Practitioner.active
Definition | Whether this practitioner's record is in active use.
Short | Whether this practitioner's record is in active use
Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Practitioner.name
Definition | Health professional’s full name. If a health professional identification number is entered, it will be the name as listed in UZI, AGB or by the healthcare center.
Short | NameInformation
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Control | 0..*
Type | HumanName
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | Naamgegevens
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Practitioner.name`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ use
30. Practitioner.name:nameInformation
Slice Name | nameInformation
Definition | This slice represents the person's official name information, including given names, last name and possibly the partner's last name.
Short | NameInformation
Comments | This `.name` element accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context SHOULD support the extensions as specified in `.given`, `.family` and `.extension:nameUsage`. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that: If 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. If parts of the family name are specified using the extensions in `.family`, the `.family` element SHOULD be populated with the full family name. Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the zib is mapped to FHIR.
Control | 0..2 This element is affected by the following invariants: ele-1
Type | HumanName(nl core NameInformation)
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | Naamgegevens, nl-core-NameInformation
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) zib-NameInformation-1: If 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-2: If 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()`) nl-core-NameInformation-01: If 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()`)
32. Practitioner.name:nameInformation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
34. Practitioner.name:nameInformation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
36. Practitioner.name:nameInformation.extension:nameUsage
Slice Name | nameUsage
Definition | A code that represents the preferred display order of the components of this human name.
Short | Preferred display order of name parts
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Assembly Order) (Extension Type: code)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. Practitioner.name:nameInformation.extension:nameUsage.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
40. Practitioner.name:nameInformation.extension:nameUsage.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. Practitioner.name:nameInformation.extension:nameUsage.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-assembly-order`
44. Practitioner.name:nameInformation.extension:nameUsage.value[x]
Definition | This concept indicates the last name or order of last names with which the person is to be addressed.
Short | NameUsage
Control | 1..1
Binding | The codes SHALL be taken from HumanNameAssemblyOrder (required to `http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1` ) Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
Type | code
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Naamgebruik
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Practitioner.name:nameInformation.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 1..1
Binding | The codes SHALL be taken from NameUse (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Pattern Value | `official`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Practitioner.name:nameInformation.text
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Short | Text representation of the full name
Comments | A representation of the full name, including given names and the family name. When implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.
Control | 0..1 This element is affected by the following invariants: nl-core-NameInformation-01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Practitioner.name:nameInformation.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept.
Control | 0..1 This element is affected by the following invariants: nl-core-NameInformation-01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) nl-core-NameInformation-02: If 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()`)
52. Practitioner.name:nameInformation.family.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. Practitioner.name:nameInformation.family.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. Practitioner.name:nameInformation.family.extension:prefix
Slice Name | prefix
Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
Short | Voorvoegsel derived from person's own surname
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Own Prefix) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
58. Practitioner.name:nameInformation.family.extension:prefix.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
60. Practitioner.name:nameInformation.family.extension:prefix.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
62. Practitioner.name:nameInformation.family.extension:prefix.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-own-prefix`
64. Practitioner.name:nameInformation.family.extension:prefix.value[x]
Definition | Prefix to the person’s own last name.
Short | Prefix
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Voorvoegsels
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Practitioner.name:nameInformation.family.extension:lastName
Slice Name | lastName
Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
Short | Portion derived from person's own surname
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Own Name) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
68. Practitioner.name:nameInformation.family.extension:lastName.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
70. Practitioner.name:nameInformation.family.extension:lastName.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
72. Practitioner.name:nameInformation.family.extension:lastName.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-own-name`
74. Practitioner.name:nameInformation.family.extension:lastName.value[x]
Definition | The person’s official last name
Short | LastName
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | Achternaam
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Practitioner.name:nameInformation.family.extension:partnerPrefix
Slice Name | partnerPrefix
Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own.
Short | Voorvoegsel derived from person's partner's surname
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Partner Prefix) (Extension Type: string)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
78. Practitioner.name:nameInformation.family.extension:partnerPrefix.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. Practitioner.name:nameInformation.family.extension:partnerPrefix.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
82. Practitioner.name:nameInformation.family.extension:partnerPrefix.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix`
84. Practitioner.name:nameInformation.family.extension:partnerPrefix.value[x]
Definition | Prefix to the partner’s last name.
Short | PartnerPrefix
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | VoorvoegselsPartner
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Practitioner.name:nameInformation.family.extension:partnerLastName
Slice Name | partnerLastName
Definition | The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.
Short | Portion derived from person's partner's surname
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Partner Name) (Extension Type: string)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
88. Practitioner.name:nameInformation.family.extension:partnerLastName.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
90. Practitioner.name:nameInformation.family.extension:partnerLastName.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.family.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
92. Practitioner.name:nameInformation.family.extension:partnerLastName.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/humanname-partner-name`
94. Practitioner.name:nameInformation.family.extension:partnerLastName.value[x]
Definition | Partner’s official last name.
Short | PartnerLastName
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Alternate Names | AchternaamPartner
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. Practitioner.name:nameInformation.family.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
98. Practitioner.name:nameInformation.given
Definition | One of a person’s official first names or the initial if the full name is not known.
Short | FirstName / Initial
Comments | This element can be used to represent full given names or initials. `extension:givenOrInitial` SHALL be used on each repretition to specifiy if it's a full name (BR) or an initial (IN). ## Zib compatibility Tthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. As noted, it SHALL be augmented with `extension:givenOrInitial`. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.
Control | 0..* This element is affected by the following invariants: nl-core-NameInformation-01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | first name, middle name, Voornaam, Initiaal
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Practitioner.name:nameInformation.given.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
102. Practitioner.name:nameInformation.given.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.given.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
104. Practitioner.name:nameInformation.given.extension:givenOrInitial
Slice Name | givenOrInitial
Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Short | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
Comments | Used to indicate additional information about the name part and how it should be used.
Control | 1..* This element is affected by the following invariants: ele-1
Type | Extension(EN Qualifier) (Extension Type: code)
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
106. Practitioner.name:nameInformation.given.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
108. Practitioner.name:nameInformation.prefix
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
Short | Titles
Comments | The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Titels
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Practitioner.name:nameInformation.suffix
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles.
Short | Titles
Comments | The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Titels
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Practitioner.name:nameInformation.period
Definition | Indicates the period of time when this name was valid for the named person.
Short | Time period when name was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows names to be placed in historical context.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Practitioner.name:nameInformation-GivenName
Slice Name | nameInformation-GivenName
Definition | This slice represents the name information normally used to address the person.
Short | Name of a human - parts and usage
Comments | This `.name` element represents the Dutch given name ("roepnaam") according to the zib NameInformation v1.1 (2020). Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the zib is mapped to FHIR.
Control | 0..* This element is affected by the following invariants: ele-1
Type | HumanName(nl core NameInformation.GivenName)
Is Modifier | false
Summary | true
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Alternate Names | nl-core-NameInformation.GivenName
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Practitioner.name:nameInformation-GivenName.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
118. Practitioner.name:nameInformation-GivenName.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
120. Practitioner.name:nameInformation-GivenName.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 1..1
Binding | The codes SHALL be taken from NameUse (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Pattern Value | `usual`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. Practitioner.name:nameInformation-GivenName.text
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Short | Text representation of the full name
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. Practitioner.name:nameInformation-GivenName.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Practitioner.name:nameInformation-GivenName.given
Definition | The name normally used to address the person.
Short | GivenName
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Control | 1..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
Summary | true
Alternate Names | first name, middle name, Roepnaam
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. Practitioner.name:nameInformation-GivenName.prefix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Short | Parts that come before the name
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. Practitioner.name:nameInformation-GivenName.suffix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Short | Parts that come after the name
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Practitioner.name:nameInformation-GivenName.period
Definition | Indicates the period of time when this name was valid for the named person.
Short | Time period when name was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows names to be placed in historical context.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Practitioner.telecom
Definition | Health professional’s telephone number(s) or e-mail address(es).
Short | ContactInformation
Comments | The cardinality mismatch between the zib (`0..1`) and FHIR (`0..*`) is explained by the containers TelephoneNumbers (`0..*`) and EmailAddresses (`0..*`) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | Contactgegevens
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Practitioner.telecom`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
136. Practitioner.telecom:telephoneNumbers
Slice Name | telephoneNumbers
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Short | TelephoneNumbers
Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.
Control | 0..* This element is affected by the following invariants: ele-1
Type | ContactPoint(nl core ContactInformation TelephoneNumbers)
Is Modifier | false
Standard Status | Normative (from Trial Use)
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | Telefoonnummers, nl-core-ContactInformation-TelephoneNumbers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cpt-2: A system is required if a value is provided. (`value.empty() or system.exists()`)
138. Practitioner.telecom:emailAddresses
Slice Name | emailAddresses
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Short | EmailAddresses
Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation.
Control | 0..* This element is affected by the following invariants: ele-1
Type | ContactPoint(nl core ContactInformation EmailAddresses)
Is Modifier | false
Standard Status | Normative (from Trial Use)
Summary | true
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have.
Alternate Names | EmailAdressen, nl-core-ContactInformation-EmailAddresses
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cpt-2: A system is required if a value is provided. (`value.empty() or system.exists()`)
140. Practitioner.address
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Short | AddressInformation
Comments | This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the zib AddressInformation v1.1 (2020). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. Separate address parts The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. Custom address types The second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The code from the zib should also be included using the extension on `Address.extension:addressType`.
zib | .ext:addressType | .use | .type
--- | --- | --- | ---
Postal Address/Postadres | PST |  | postal
Primary Home/Officieel adres | HP | home | both
Visit Address/Woon-/verblijfadres | PHYS | home | physical
Temporary Address/Tijdelijk adres | TMP | temp |
Work Place/Werkadres | WP | work |
Vacation Home/Vakantie adres | HV | temp |
If `Address.type` is both then this is to be understood as a dual purpose address (postal and physical), unless a specific postal type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. Note: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Address(nl core AddressInformation)
Is Modifier | false
Summary | true
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
Alternate Names | Adresgegevens, nl-core-AddressInformation
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Practitioner.gender
Definition | Patient’s administrative gender.
Short | Gender
Control | 0..1
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` ) 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.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed to address the person correctly.
Alternate Names | Geslacht
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Practitioner.gender.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
146. Practitioner.gender.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.gender.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
148. Practitioner.gender.extension:genderCodelist
Slice Name | genderCodelist
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(ext CodeSpecification) (Extension Type: CodeableConcept)
Is Modifier | false
Standard Status | Normative (from Trial Use)
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
150. Practitioner.gender.extension:genderCodelist.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
152. Practitioner.gender.extension:genderCodelist.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Practitioner.gender.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
154. Practitioner.gender.extension:genderCodelist.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification`
156. Practitioner.gender.extension:genderCodelist.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Binding | The codes SHALL be taken from GeslachtCodelijst (2020-09-01T00:00:00) (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.8--20200901000000|2020-09-01T00:00:00` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. Practitioner.gender.value
Definition | Primitive value for code
Short | Primitive value for code
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
160. Practitioner.birthDate
Definition | The date of birth for the practitioner.
Short | The date on which the practitioner was born
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed for identification.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. Practitioner.photo
Definition | Image of the person.
Short | Image of the person
Control | 0..*
Type | Attachment
Is Modifier | false
Summary | false
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. Practitioner.qualification
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Short | Certification, licenses, or training pertaining to the provision of care
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. Practitioner.qualification.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
168. Practitioner.qualification.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
170. Practitioner.qualification.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
172. Practitioner.qualification.identifier
Definition | An identifier that applies to this person's qualification in this role.
Short | An identifier for this qualification for the practitioner
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | false
Requirements | Often, specific identities are assigned for the qualification.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. Practitioner.qualification.code
Definition | Coded representation of the qualification.
Short | Coded representation of the qualification
Control | 1..1
Binding | For example codes, see v2.0360.2.7 (0360) (example to `http://terminology.hl7.org/ValueSet/v2-2.7-0360|0360` ) Specific qualification the practitioner has to provide a service.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. Practitioner.qualification.period
Definition | Period during which the qualification is valid.
Short | Period during which the qualification is valid
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
Requirements | Qualifications are often for a limited period of time, and can be revoked.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. Practitioner.qualification.issuer
Definition | Organization that regulates and issues the qualification.
Short | Organization that regulates and issues the qualification
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. Practitioner.communication
Definition | A language the practitioner can use in patient communication.
Short | A language the practitioner can use in patient communication
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Control | 0..*
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)