Koppeltaal 2.0 Implementation Guide (Full Documentation)
1.4.5-beta.002 - ci-build
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v1.4.5-beta.002) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2023-01-24 |
Definitions for the KT2Practitioner resource profile.
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 | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
4. Practitioner.extension:resource-origin | |||||||||||||||||||||||||||||
Slice Name | resource-origin | ||||||||||||||||||||||||||||
Definition | Defines the author of the resource. | ||||||||||||||||||||||||||||
Short | Extension | ||||||||||||||||||||||||||||
Comments | Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | Extension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device)) | ||||||||||||||||||||||||||||
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()) | ||||||||||||||||||||||||||||
6. 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()) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
8. 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:
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 | 10..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
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: | ||||||||||||||||||||||||||||
10. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
12. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
14. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
16. 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 | 10..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())) | ||||||||||||||||||||||||||||
18. 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:
| ||||||||||||||||||||||||||||
Control | 10..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
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())) kt2pnu-1: Practitioner name use must not be empty ( use.hasValue() ) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.name . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
20. 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 Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another 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:
| ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
22. 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 | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
24. Practitioner.name:nameInformation.extension:nameUsage.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
26. 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 | ||||||||||||||||||||||||||||
28. 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())) | ||||||||||||||||||||||||||||
30. 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 NameUsehttp://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())) | ||||||||||||||||||||||||||||
32. 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 | This element is not used in the context of Koppeltaal 2.0 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 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())) | ||||||||||||||||||||||||||||
34. 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 | 10..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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
36. 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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
38. Practitioner.name:nameInformation.family.extension:prefix.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
40. 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 | ||||||||||||||||||||||||||||
42. 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())) | ||||||||||||||||||||||||||||
44. 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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
46. Practitioner.name:nameInformation.family.extension:lastName.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
48. 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 | ||||||||||||||||||||||||||||
50. 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())) | ||||||||||||||||||||||||||||
52. 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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
54. Practitioner.name:nameInformation.family.extension:partnerPrefix.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
56. 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 | ||||||||||||||||||||||||||||
58. 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())) | ||||||||||||||||||||||||||||
60. 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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
62. Practitioner.name:nameInformation.family.extension:partnerLastName.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
64. 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 | ||||||||||||||||||||||||||||
66. 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())) | ||||||||||||||||||||||||||||
68. Practitioner.name:nameInformation.given | |||||||||||||||||||||||||||||
Definition | One of a person’s official first names or the initial if the full name is not known. Given name. | ||||||||||||||||||||||||||||
Short | FirstName / InitialGiven names (not always 'first'). Includes middle names | ||||||||||||||||||||||||||||
Comments | This element can be used to represent full given names or initials. Zib compatibilityTthis 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:
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 Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single 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..* 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())) | ||||||||||||||||||||||||||||
70. Practitioner.name:nameInformation.given.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 | 10..* | ||||||||||||||||||||||||||||
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: | ||||||||||||||||||||||||||||
72. 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 | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
74. Practitioner.name:nameInformation.prefix | |||||||||||||||||||||||||||||
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles. 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 | TitlesParts that come before the name | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
76. Practitioner.name:nameInformation.suffix | |||||||||||||||||||||||||||||
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles. 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 | TitlesParts that come after the name | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
78. 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 | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-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())) per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
80. 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 Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other 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:
| ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
82. 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 NameUsehttp://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())) | ||||||||||||||||||||||||||||
84. 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 | This element is not used in the context of Koppeltaal 2.0 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())) | ||||||||||||||||||||||||||||
86. 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())) | ||||||||||||||||||||||||||||
88. 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 | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
90. 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 | ||||||||||||||||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
92. 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 | ||||||||||||||||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
94. 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 | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-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())) per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
96. 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 ( 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 | 10..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
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 | 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())) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.telecom . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
98. 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 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 | ||||||||||||||||||||||||||||
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 | 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())) | ||||||||||||||||||||||||||||
100. Practitioner.telecom:telephoneNumbers.extension:comment | |||||||||||||||||||||||||||||
Slice Name | comment | ||||||||||||||||||||||||||||
Definition | Optional Extension Element - found in all resources. | ||||||||||||||||||||||||||||
Short | Optional Extensions Element | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Extension(ext Comment) (Extension Type: string) | ||||||||||||||||||||||||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
102. Practitioner.telecom:telephoneNumbers.extension:comment.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. | ||||||||||||||||||||||||||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||||||||||||||||||||||||||
104. Practitioner.telecom:telephoneNumbers.system | |||||||||||||||||||||||||||||
Definition | The telecom or device type that the telephone number is connected to. Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||||||||||||||||||||||||
Short | TelecomTypephone | fax | email | pager | url | sms | other | ||||||||||||||||||||||||||||
Control | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbershttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem )Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. Telecommunications form for contact point. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Alternate Names | TelecomType | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
106. Practitioner.telecom:telephoneNumbers.system.extension:telecomType | |||||||||||||||||||||||||||||
Slice Name | telecomType | ||||||||||||||||||||||||||||
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..1 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
108. Practitioner.telecom:telephoneNumbers.system.extension:telecomType.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. | ||||||||||||||||||||||||||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | ||||||||||||||||||||||||||||
110. Practitioner.telecom:telephoneNumbers.use | |||||||||||||||||||||||||||||
Definition | NumberType indicates whether the number is a landline, temporary, work telephone number. Identifies the purpose for the contact point. | ||||||||||||||||||||||||||||
Short | NumberTypehome | work | temp | old | mobile - purpose of this contact point | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointUse ValueSet for zib ContactInformation TelephoneNumbershttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse )Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. Use of contact point. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||||||||||||||||||||||||
Alternate Names | NummerSoort | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
112. Practitioner.telecom:telephoneNumbers.rank | |||||||||||||||||||||||||||||
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||||||||||||||||||||||||||
Short | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | positiveInt | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
114. Practitioner.telecom:telephoneNumbers.period | |||||||||||||||||||||||||||||
Definition | Time period when the contact point was/is in use. | ||||||||||||||||||||||||||||
Short | Time period when the contact point was/is in use | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
116. 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 | 10..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | ContactPoint(nl core ContactInformation EmailAddresses) | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
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 | 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())) | ||||||||||||||||||||||||||||
118. Practitioner.telecom:emailAddresses.system | |||||||||||||||||||||||||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||||||||||||||||||||||||
Short | emailphone | fax | email | pager | url | sms | other | ||||||||||||||||||||||||||||
Control | 10..1 This element is affected by the following invariants: cpt-2 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Pattern Value | email | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
120. Practitioner.telecom:emailAddresses.use | |||||||||||||||||||||||||||||
Definition | EmailAddressType indicates whether it is a private or business e-mail address. Identifies the purpose for the contact point. | ||||||||||||||||||||||||||||
Short | EmailAddressTypehome | work | temp | old | mobile - purpose of this contact point | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointUse ValueSet for zib ContactInformation EmailAddresshttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse )Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse. Use of contact point. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||||||||||||||||||||||||
Alternate Names | EmailSoort | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
122. Practitioner.telecom:emailAddresses.rank | |||||||||||||||||||||||||||||
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||||||||||||||||||||||||||
Short | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | positiveInt | ||||||||||||||||||||||||||||
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())) | ||||||||||||||||||||||||||||
124. Practitioner.telecom:emailAddresses.period | |||||||||||||||||||||||||||||
Definition | Time period when the contact point was/is in use. | ||||||||||||||||||||||||||||
Short | Time period when the contact point was/is in use | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
126. 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. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | ||||||||||||||||||||||||||||
Short | AddressInformationAddress(es) of the practitioner that are not role specific (typically home address) | ||||||||||||||||||||||||||||
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
If 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. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). | ||||||||||||||||||||||||||||
Control | 0..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())) | ||||||||||||||||||||||||||||
128. Practitioner.photo | |||||||||||||||||||||||||||||
Definition | Image of the person. | ||||||||||||||||||||||||||||
Short | Image of the person | ||||||||||||||||||||||||||||
Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||||||||||||||||||||||||||||
Control | 0..0* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Attachment | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||||||||||||||||||||||||||||
Invariants | att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
130. 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..0* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
134. 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..0* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
Is Modifier | 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())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Practitioner | |
2. Practitioner.extension:resource-origin | |
Slice Name | resource-origin |
Control | 0..* |
Type | Extension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device)) |
4. Practitioner.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
6. Practitioner.active | |
Control | 1..? |
8. Practitioner.name | |
Control | 1..? |
Invariants | kt2pnu-1: Practitioner name use must not be empty (use.hasValue() ) |
10. Practitioner.name:nameInformation | |
Slice Name | nameInformation |
Comments | This Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the zib is mapped to FHIR. |
12. Practitioner.name:nameInformation.extension:nameUsage | |
Slice Name | nameUsage |
Comments | This element is not used in the context of Koppeltaal 2.0 |
14. Practitioner.name:nameInformation.text | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
16. Practitioner.name:nameInformation.family | |
Control | 1..? |
18. Practitioner.name:nameInformation.given | |
Control | 1..? |
20. Practitioner.name:nameInformation.prefix | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
22. Practitioner.name:nameInformation.suffix | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
24. Practitioner.name:nameInformation.period | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
26. Practitioner.name:nameInformation-GivenName | |
Slice Name | nameInformation-GivenName |
28. Practitioner.name:nameInformation-GivenName.text | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
30. Practitioner.name:nameInformation-GivenName.period | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
32. Practitioner.telecom | |
Control | 1..? |
34. Practitioner.telecom:telephoneNumbers | |
Slice Name | telephoneNumbers |
36. Practitioner.telecom:telephoneNumbers.extension:comment | |
Slice Name | comment |
Comments | This element is not used in the context of Koppeltaal 2.0 |
38. Practitioner.telecom:telephoneNumbers.use | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
40. Practitioner.telecom:telephoneNumbers.rank | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
42. Practitioner.telecom:telephoneNumbers.period | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
44. Practitioner.telecom:emailAddresses | |
Slice Name | emailAddresses |
Control | 1..? |
46. Practitioner.telecom:emailAddresses.use | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
48. Practitioner.telecom:emailAddresses.rank | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
50. Practitioner.telecom:emailAddresses.period | |
Comments | This element is not used in the context of Koppeltaal 2.0 |
52. Practitioner.address | |
Control | 0..0 |
54. Practitioner.photo | |
Control | 0..0 |
56. Practitioner.qualification | |
Control | 0..0 |
58. Practitioner.communication | |
Control | 0..0 |
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 | ||||||||||||||||||||||||||||
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 )A human language.
| ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
16. Practitioner.extension:resource-origin | |||||||||||||||||||||||||||||
Slice Name | resource-origin | ||||||||||||||||||||||||||||
Definition | Defines the author of the resource. | ||||||||||||||||||||||||||||
Short | Extension | ||||||||||||||||||||||||||||
Comments | Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it. | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | Extension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device)) | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
18. 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() ) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
20. 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:
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 | 1..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
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: | ||||||||||||||||||||||||||||
22. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
24. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
26. 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..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||||||||||||||||||||||||
Pattern Value | { | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
28. 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 | 1..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()) ) | ||||||||||||||||||||||||||||
30. 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:
| ||||||||||||||||||||||||||||
Control | 1..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
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()) )kt2pnu-1: Practitioner name use must not be empty ( use.hasValue() ) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.name . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
32. 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 Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another 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() ) | ||||||||||||||||||||||||||||
34. 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 | ||||||||||||||||||||||||||||
36. 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: | ||||||||||||||||||||||||||||
38. 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 | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
40. 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 | ||||||||||||||||||||||||||||
42. Practitioner.name:nameInformation.extension:nameUsage.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
44. 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 | ||||||||||||||||||||||||||||
46. 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()) ) | ||||||||||||||||||||||||||||
48. 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()) ) | ||||||||||||||||||||||||||||
50. 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 | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
52. 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 | 1..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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
54. Practitioner.name:nameInformation.family.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 | ||||||||||||||||||||||||||||
56. Practitioner.name:nameInformation.family.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.family.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
58. 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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
60. 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 | ||||||||||||||||||||||||||||
62. Practitioner.name:nameInformation.family.extension:prefix.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
64. 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 | ||||||||||||||||||||||||||||
66. 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()) ) | ||||||||||||||||||||||||||||
68. 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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
70. 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 | ||||||||||||||||||||||||||||
72. Practitioner.name:nameInformation.family.extension:lastName.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
74. 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 | ||||||||||||||||||||||||||||
76. 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()) ) | ||||||||||||||||||||||||||||
78. 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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
80. 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 | ||||||||||||||||||||||||||||
82. Practitioner.name:nameInformation.family.extension:partnerPrefix.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
84. 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 | ||||||||||||||||||||||||||||
86. 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()) ) | ||||||||||||||||||||||||||||
88. 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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
90. 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 | ||||||||||||||||||||||||||||
92. Practitioner.name:nameInformation.family.extension:partnerLastName.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..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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
94. 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 | ||||||||||||||||||||||||||||
96. 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()) ) | ||||||||||||||||||||||||||||
98. Practitioner.name:nameInformation.family.value | |||||||||||||||||||||||||||||
Definition | Primitive value for string | ||||||||||||||||||||||||||||
Short | Primitive value for string | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Max Length: | 1048576 | ||||||||||||||||||||||||||||
100. 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. Zib compatibilityTthis 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:
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 Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single | ||||||||||||||||||||||||||||
Control | 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 | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
102. Practitioner.name:nameInformation.given.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 | ||||||||||||||||||||||||||||
104. Practitioner.name:nameInformation.given.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 | 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: | ||||||||||||||||||||||||||||
106. 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 | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
108. Practitioner.name:nameInformation.given.value | |||||||||||||||||||||||||||||
Definition | Primitive value for string | ||||||||||||||||||||||||||||
Short | Primitive value for string | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Max Length: | 1048576 | ||||||||||||||||||||||||||||
110. Practitioner.name:nameInformation.prefix | |||||||||||||||||||||||||||||
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles. | ||||||||||||||||||||||||||||
Short | Titles | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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.suffix | |||||||||||||||||||||||||||||
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles. | ||||||||||||||||||||||||||||
Short | Titles | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
114. 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 | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-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()) )per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
116. 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 Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other 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()) ) | ||||||||||||||||||||||||||||
118. 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 | ||||||||||||||||||||||||||||
120. 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: | ||||||||||||||||||||||||||||
122. 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()) ) | ||||||||||||||||||||||||||||
124. 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 | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
126. 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()) ) | ||||||||||||||||||||||||||||
128. 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 | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
130. 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 | ||||||||||||||||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||||||||||||||||||||||||
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.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 | ||||||||||||||||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
134. 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 | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-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()) )per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
136. Practitioner.telecom | |||||||||||||||||||||||||||||
Definition | Health professional’s telephone number(s) or e-mail address(es). | ||||||||||||||||||||||||||||
Short | ContactInformation | ||||||||||||||||||||||||||||
Comments | The cardinality mismatch between the zib ( | ||||||||||||||||||||||||||||
Control | 1..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
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 | 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()) ) | ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices on Practitioner.telecom . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
138. 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 | ||||||||||||||||||||||||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | ContactPoint(nl core ContactInformation TelephoneNumbers) | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
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 | 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()) ) | ||||||||||||||||||||||||||||
140. Practitioner.telecom:telephoneNumbers.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 | ||||||||||||||||||||||||||||
142. Practitioner.telecom:telephoneNumbers.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.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
144. Practitioner.telecom:telephoneNumbers.extension:comment | |||||||||||||||||||||||||||||
Slice Name | comment | ||||||||||||||||||||||||||||
Definition | Optional Extension Element - found in all resources. | ||||||||||||||||||||||||||||
Short | Optional Extensions Element | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Extension(ext Comment) (Extension Type: string) | ||||||||||||||||||||||||||||
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() ) | ||||||||||||||||||||||||||||
146. Practitioner.telecom:telephoneNumbers.extension:comment.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 | ||||||||||||||||||||||||||||
148. Practitioner.telecom:telephoneNumbers.extension:comment.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.telecom.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
150. Practitioner.telecom:telephoneNumbers.extension:comment.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 | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||||||||||||||||||||||||||
152. Practitioner.telecom:telephoneNumbers.extension:comment.value[x] | |||||||||||||||||||||||||||||
Definition | Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionnels) or that availability by phone is only possible during a specified part of the day. | ||||||||||||||||||||||||||||
Short | Comment | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-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 | ||||||||||||||||||||||||||||
Alternate Names | Toelichting | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
154. Practitioner.telecom:telephoneNumbers.system | |||||||||||||||||||||||||||||
Definition | The telecom or device type that the telephone number is connected to. | ||||||||||||||||||||||||||||
Short | TelecomType | ||||||||||||||||||||||||||||
Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem )Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Alternate Names | TelecomType | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
156. Practitioner.telecom:telephoneNumbers.system.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 | ||||||||||||||||||||||||||||
158. Practitioner.telecom:telephoneNumbers.system.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.telecom.system.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
160. Practitioner.telecom:telephoneNumbers.system.extension:telecomType | |||||||||||||||||||||||||||||
Slice Name | telecomType | ||||||||||||||||||||||||||||
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..1 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() ) | ||||||||||||||||||||||||||||
162. Practitioner.telecom:telephoneNumbers.system.extension:telecomType.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 | ||||||||||||||||||||||||||||
164. Practitioner.telecom:telephoneNumbers.system.extension:telecomType.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.telecom.system.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
166. Practitioner.telecom:telephoneNumbers.system.extension:telecomType.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 | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | ||||||||||||||||||||||||||||
168. Practitioner.telecom:telephoneNumbers.system.extension:telecomType.value[x] | |||||||||||||||||||||||||||||
Definition | The telecom or device type that the telephone number is connected to. | ||||||||||||||||||||||||||||
Short | TelecomType | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from TelecomTypeCodelijst (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 ) | ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Alternate Names | TelecomType | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
170. Practitioner.telecom:telephoneNumbers.system.value | |||||||||||||||||||||||||||||
Definition | Primitive value for code | ||||||||||||||||||||||||||||
Short | Primitive value for code | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Max Length: | 1048576 | ||||||||||||||||||||||||||||
172. Practitioner.telecom:telephoneNumbers.value | |||||||||||||||||||||||||||||
Definition | The person's telephone number. | ||||||||||||||||||||||||||||
Short | TelephoneNumber | ||||||||||||||||||||||||||||
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||||||||||||||||||||||||||
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 | Need to support legacy numbers that are not in a tightly controlled format. | ||||||||||||||||||||||||||||
Alternate Names | Telefoonnummer | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
174. Practitioner.telecom:telephoneNumbers.use | |||||||||||||||||||||||||||||
Definition | NumberType indicates whether the number is a landline, temporary, work telephone number. | ||||||||||||||||||||||||||||
Short | NumberType | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse )Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||||||||||||||||||||||||
Alternate Names | NummerSoort | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
176. Practitioner.telecom:telephoneNumbers.rank | |||||||||||||||||||||||||||||
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||||||||||||||||||||||||||
Short | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | positiveInt | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
178. Practitioner.telecom:telephoneNumbers.period | |||||||||||||||||||||||||||||
Definition | Time period when the contact point was/is in use. | ||||||||||||||||||||||||||||
Short | Time period when the contact point was/is in use | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
180. 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 | 1..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | ContactPoint(nl core ContactInformation EmailAddresses) | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
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 | 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()) ) | ||||||||||||||||||||||||||||
182. Practitioner.telecom:emailAddresses.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 | ||||||||||||||||||||||||||||
184. Practitioner.telecom:emailAddresses.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.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
186. Practitioner.telecom:emailAddresses.system | |||||||||||||||||||||||||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||||||||||||||||||||||||
Short | |||||||||||||||||||||||||||||
Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Pattern Value | email | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
188. Practitioner.telecom:emailAddresses.value | |||||||||||||||||||||||||||||
Definition | The person's e-mail address | ||||||||||||||||||||||||||||
Short | EmailAddress | ||||||||||||||||||||||||||||
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||||||||||||||||||||||||||
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 | Need to support legacy numbers that are not in a tightly controlled format. | ||||||||||||||||||||||||||||
Alternate Names | EmailAdres | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
190. Practitioner.telecom:emailAddresses.use | |||||||||||||||||||||||||||||
Definition | EmailAddressType indicates whether it is a private or business e-mail address. | ||||||||||||||||||||||||||||
Short | EmailAddressType | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from ContactPointUse ValueSet for zib ContactInformation EmailAddress (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse )Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse. | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||||||||||||||||||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||||||||||||||||||||||||
Alternate Names | EmailSoort | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
192. Practitioner.telecom:emailAddresses.rank | |||||||||||||||||||||||||||||
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||||||||||||||||||||||||||
Short | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | positiveInt | ||||||||||||||||||||||||||||
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()) ) | ||||||||||||||||||||||||||||
194. Practitioner.telecom:emailAddresses.period | |||||||||||||||||||||||||||||
Definition | Time period when the contact point was/is in use. | ||||||||||||||||||||||||||||
Short | Time period when the contact point was/is in use | ||||||||||||||||||||||||||||
Comments | This element is not used in the context of Koppeltaal 2.0 | ||||||||||||||||||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) | ||||||||||||||||||||||||||||
196. 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
If 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..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()) ) | ||||||||||||||||||||||||||||
198. 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()) ) | ||||||||||||||||||||||||||||
200. 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 | ||||||||||||||||||||||||||||
202. 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: | ||||||||||||||||||||||||||||
204. 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() ) | ||||||||||||||||||||||||||||
206. 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 | ||||||||||||||||||||||||||||
208. 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: | ||||||||||||||||||||||||||||
210. 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 | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | ||||||||||||||||||||||||||||
212. 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 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Binding | The codes SHALL be taken from GeslachtCodelijst (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.8--20200901000000 ) | ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Standard Status | Normative (from Trial Use) | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
214. Practitioner.gender.value | |||||||||||||||||||||||||||||
Definition | Primitive value for code | ||||||||||||||||||||||||||||
Short | Primitive value for code | ||||||||||||||||||||||||||||
Control | 0..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Max Length: | 1048576 | ||||||||||||||||||||||||||||
216. 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()) ) | ||||||||||||||||||||||||||||
218. Practitioner.photo | |||||||||||||||||||||||||||||
Definition | Image of the person. | ||||||||||||||||||||||||||||
Short | Image of the person | ||||||||||||||||||||||||||||
Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||||||||||||||||||||||||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | Attachment | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||||||||||||||||||||||||||||
Invariants | att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists() )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
220. 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..0 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Is Modifier | false | ||||||||||||||||||||||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||||||||||||||||||||||
229. 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..0 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
Is Modifier | 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()) ) |