Koppeltaal 2.0 Implementation Guide (Full Documentation)
1.4.5-beta.002 - ci-build Netherlands flag

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

Resource Profile: KT2_Patient - Detailed Descriptions

Draft as of 2023-01-24

Definitions for the KT2Patient resource profile.

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

0. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

ShortPatientInformation about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident, Patient, nl-core-Patient
Invariantsdom-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. Patient.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.

ShortA 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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Patient.extension:nationality
Slice Namenationality
Definition

The nationality of the patient.

ShortNationality
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension(Patient Nationality) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Patient.extension:resource-origin
Slice Nameresource-origin
Definition

Defines the author of the resource.

ShortExtension
Comments

Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it.

Control0..1
TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
Is Modifierfalse
Summaryfalse
Invariantsele-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. Patient.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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Patient.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 20. Patient.identifier
    Definition

    The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example.


    An identifier for this patient.

    ShortPatientIdentificationNumberAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    This element is affected by the following invariants: ele-1
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Patients are almost always assigned specific numerical identifiers.

    Alternate NamesIdentificatienummer
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 22. Patient.identifier:bsn
      Slice Namebsn
      Definition

      An identifier for this patient.

      ShortAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeIdentifier
      Is Modifierfalse
      Standard StatusNormative (from Normative)
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Pattern Value{
        "system" : "http://fhir.nl/fhir/NamingSystem/bsn"
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Patient.active
      Definition

      Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

      It is often used to filter patient lists to exclude inactive patients

      Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

      ShortWhether this patient's record is in active use
      Comments

      If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

      Control10..1
      Typeboolean
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to mark a patient record as not to be used because it was created in error.

      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Patient.name
      Definition

      Patient's full name.


      A name associated with the individual.

      ShortNameInformation / PayerNameA name associated with the patient
      Comments

      A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

      Control10..*
      This element is affected by the following invariants: ele-1
      TypeHumanName
      Is Modifierfalse
      Summarytrue
      Requirements

      Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

      Alternate NamesNaamgegevens, BetalerNaam
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      kt2pnu-2: Patient name use must not be empty (use.hasValue())
      SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ use
      • 28. Patient.name:nameInformation
        Slice NamenameInformation
        Definition

        This slice represents the person's official name information, including given names, last name and possibly the partner's last name.


        A name associated with the individual.

        ShortNameInformationA name associated with the patient
        Comments

        This .name element represents a Dutch name according to the zib NameInformation (v1.1, 2020) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on .family and on .extension:nameUsage for more information. Systems that need to work in a Dutch context MUST support these extensions as specified here. In addition, systems MUST use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the .text element.

        Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on .given on how to map the FirstNames and Initials concepts, and on .prefix/.suffix on how to map the Titles concept.

        Note 2: This element should only contain a person's official names. The GivenName concept is represented in another .name element with .name.use = usual.

        Note 3: The examples illustrate how the zib is mapped to FHIR.


        A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

        Control0..2*
        This element is affected by the following invariants: ele-1
        TypeHumanName(nl core NameInformation)
        Is Modifierfalse
        Summarytrue
        Requirements

        Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

        Alternate NamesNaamgegevens, nl-core-NameInformation
        Invariantsele-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())
        30. Patient.name:nameInformation.extension:nameUsage
        Slice NamenameUsage
        Definition

        A code that represents the preferred display order of the components of this human name.

        ShortPreferred display order of name parts
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Assembly Order) (Extension Type: code)
        Is Modifierfalse
        Standard StatusNormative (from Normative)
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        32. Patient.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.

        ShortAdditional 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.

        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 34. Patient.name:nameInformation.extension:nameUsage.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies 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.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order
          36. Patient.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).

          ShortNameUsageValue of extension
          Control10..1
          BindingThe 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.

          Typecode, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Alternate NamesNaamgebruik
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. Patient.name:nameInformation.use
          Definition

          Identifies the purpose for this name.

          Shortusual | 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.

          Control10..1
          BindingThe 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.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate name for a particular context of use to be selected from among a set of names.

          Pattern Valueofficial
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. Patient.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.

          ShortText 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.

          Control0..1
          This element is affected by the following invariants: nl-core-NameInformation-01
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          A renderable, unencoded form.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. Patient.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.

          ShortFamily 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).

          Control10..1
          This element is affected by the following invariants: nl-core-NameInformation-01
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate Namessurname
          Invariantsele-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())
          44. Patient.name:nameInformation.family.extension:prefix
          Slice Nameprefix
          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.

          ShortVoorvoegsel 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.

          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Own Prefix) (Extension Type: string)
          Is Modifierfalse
          Standard StatusNormative (from Normative)
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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. Patient.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.

          ShortAdditional 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.

          Control0..0*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 48. Patient.name:nameInformation.family.extension:prefix.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies 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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix
            50. Patient.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).

            ShortPrefixValue of extension
            Control10..1
            Typestring, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Alternate NamesVoorvoegsels
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Patient.name:nameInformation.family.extension:lastName
            Slice NamelastName
            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.

            ShortPortion 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".

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Own Name) (Extension Type: string)
            Is Modifierfalse
            Standard StatusNormative (from Normative)
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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. Patient.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.

            ShortAdditional 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.

            Control0..0*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 56. Patient.name:nameInformation.family.extension:lastName.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies 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.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-name
              58. Patient.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).

              ShortLastNameValue of extension
              Control10..1
              Typestring, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Alternate NamesAchternaam
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. Patient.name:nameInformation.family.extension:partnerPrefix
              Slice NamepartnerPrefix
              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.

              ShortVoorvoegsel 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.

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Partner Prefix) (Extension Type: string)
              Is Modifierfalse
              Standard StatusNormative (from Normative)
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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. Patient.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.

              ShortAdditional 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.

              Control0..0*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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())
              SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 64. Patient.name:nameInformation.family.extension:partnerPrefix.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies 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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
                66. Patient.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).

                ShortPartnerPrefixValue of extension
                Control10..1
                Typestring, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Alternate NamesVoorvoegselsPartner
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                68. Patient.name:nameInformation.family.extension:partnerLastName
                Slice NamepartnerLastName
                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.

                ShortPortion 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".

                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Partner Name) (Extension Type: string)
                Is Modifierfalse
                Standard StatusNormative (from Normative)
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                70. Patient.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.

                ShortAdditional 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.

                Control0..0*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 72. Patient.name:nameInformation.family.extension:partnerLastName.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies 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.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-name
                  74. Patient.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).

                  ShortPartnerLastNameValue of extension
                  Control10..1
                  Typestring, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Alternate NamesAchternaamPartner
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  76. Patient.name:nameInformation.given
                  Definition

                  One of a person’s official first names or the initial if the full name is not known.


                  Given name.

                  ShortFirstName / InitialGiven names (not always 'first'). Includes middle names
                  Comments

                  This element can be used to represent full given names or initials. extension:givenOrInitial SHALL be used on each repretition to specifiy if it's a full name (BR) or an initial (IN).

                  Zib compatibility

                  Tthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.

                  Therefore, the zib concepts are implemented here in the following way:

                  • Systems SHOULD use a .given element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).
                  • Each of these elements:
                    • SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.
                    • As noted, it SHALL be augmented with extension:givenOrInitial.

                  Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.

                  If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional .name instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.

                  Note 1: The GivenName concept should not be included here but in a separate .name instance where .use = usual.

                  Note 2: As specified by FHIR, multiple official first names MAY be combined in a single .given element (separated by spaces), as long as the .given elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.


                  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.

                  Control10..*
                  This element is affected by the following invariants: nl-core-NameInformation-01
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate Namesfirst name, middle name, Voornaam, Initiaal
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  78. Patient.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.

                  ShortAdditional 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.

                  Control10..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-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())
                  SlicingThis element introduces a set of slices on Patient.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 80. Patient.name:nameInformation.given.extension:givenOrInitial
                    Slice NamegivenOrInitial
                    Definition

                    A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

                    ShortLS | 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.

                    Control1..*
                    This element is affected by the following invariants: ele-1
                    TypeExtension(EN Qualifier) (Extension Type: code)
                    Is Modifierfalse
                    Standard StatusNormative (from Normative)
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-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())
                    82. Patient.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.

                    ShortTitlesParts that come before the name
                    Comments

                    This element is not used in the context of Koppeltaal 2.0

                    Control0..*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesTitels
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Patient.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.

                    ShortTitlesParts that come after the name
                    Comments

                    This element is not used in the context of Koppeltaal 2.0

                    Control0..*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesTitels
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Patient.name:nameInformation.period
                    Definition

                    Indicates the period of time when this name was valid for the named person.

                    ShortTime period when name was/is in use
                    Comments

                    This element is not used in the context of Koppeltaal 2.0

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows names to be placed in historical context.

                    Invariantsele-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))
                    88. Patient.name:nameInformation-GivenName
                    Slice NamenameInformation-GivenName
                    Definition

                    This slice represents the name information normally used to address the person.


                    A name associated with the individual.

                    ShortName of a human - parts and usageA name associated with the patient
                    Comments

                    This .name element represents the Dutch given name ("roepnaam") according to the zib NameInformation v1.1 (2020).

                    Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other .name elements with .name.use = official.

                    Note 2: The examples illustrate how the zib is mapped to FHIR.


                    A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                    Control0..*
                    This element is affected by the following invariants: ele-1
                    TypeHumanName(nl core NameInformation.GivenName)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                    Alternate Namesnl-core-NameInformation.GivenName
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. Patient.name:nameInformation-GivenName.use
                    Definition

                    Identifies the purpose for this name.

                    Shortusual | 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.

                    Control10..1
                    BindingThe 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.

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate name for a particular context of use to be selected from among a set of names.

                    Pattern Valueusual
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    92. Patient.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.

                    ShortText 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.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    A renderable, unencoded form.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    94. Patient.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.

                    ShortFamily name (often called 'Surname')
                    Comments

                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                    Control0..01
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate Namessurname
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    96. Patient.name:nameInformation-GivenName.given
                    Definition

                    The name normally used to address the person.


                    Given name.

                    ShortGivenNameGiven 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.

                    Control10..*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate Namesfirst name, middle name, Roepnaam
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    98. Patient.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.

                    ShortParts that come before the name
                    Comments

                    Note that FHIR strings SHALL NOT exceed 1MB in size

                    Control0..0*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    100. Patient.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.

                    ShortParts that come after the name
                    Comments

                    Note that FHIR strings SHALL NOT exceed 1MB in size

                    Control0..0*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    102. Patient.telecom
                    Definition

                    Patient’s telephone number(s) or e-mail address(es).


                    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                    ShortContactInformationA contact detail for the individual
                    Comments

                    The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.


                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                    Control0..*
                    This element is affected by the following invariants: ele-1
                    TypeContactPoint
                    Is Modifierfalse
                    Standard StatusNormative (from Normative)
                    Summarytrue
                    Requirements

                    People have (primary) ways to contact them in some way such as phone, email.

                    Alternate NamesContactgegevens
                    Invariantscpt-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()))
                    SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • profile @ $this
                    • 104. Patient.telecom:telephoneNumbers
                      Slice NametelephoneNumbers
                      Definition

                      Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


                      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                      ShortTelephoneNumbersA contact detail for the individual
                      Comments

                      Implementation of the "TelephoneNumbers" concept of zib ContactInformation.

                      Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts ContactPoint.system and ContactPoint.use respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on ContactPoint.system is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.


                      A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeContactPoint(nl core ContactInformation TelephoneNumbers)
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      People have (primary) ways to contact them in some way such as phone, email.

                      Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
                      Invariantscpt-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()))
                      106. Patient.telecom:telephoneNumbers.extension:comment
                      Slice Namecomment
                      Definition

                      Optional Extension Element - found in all resources.

                      ShortOptional 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.

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(ext Comment) (Extension Type: string)
                      Is Modifierfalse
                      Standard StatusNormative (from Normative)
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-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. Patient.telecom:telephoneNumbers.extension:comment.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies 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.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-Comment
                      110. Patient.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.

                      ShortTelecomTypephone | fax | email | pager | url | sms | other
                      Control10..1
                      This element is affected by the following invariants: cpt-2
                      BindingThe 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.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesTelecomType
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Patient.telecom:telephoneNumbers.system.extension:telecomType
                      Slice NametelecomType
                      Definition

                      Optional Extension Element - found in all resources.

                      ShortOptional 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.

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                      Is Modifierfalse
                      Standard StatusNormative (from Normative)
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-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())
                      114. Patient.telecom:telephoneNumbers.system.extension:telecomType.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies 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.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                      116. Patient.telecom:telephoneNumbers.use
                      Definition

                      NumberType indicates whether the number is a landline, temporary, work telephone number.


                      Identifies the purpose for the contact point.

                      ShortNumberTypehome | work | temp | old | mobile - purpose of this contact point
                      Comments

                      Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                      Control0..1
                      BindingThe 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.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                      Alternate NamesNummerSoort
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      118. Patient.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.

                      ShortSpecify 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.

                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      120. Patient.telecom:telephoneNumbers.period
                      Definition

                      Time period when the contact point was/is in use.

                      ShortTime period when the contact point was/is in use
                      Comments

                      This element is not used in the context of Koppeltaal 2.0

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-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))
                      122. Patient.telecom:emailAddresses
                      Slice NameemailAddresses
                      Definition

                      Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


                      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                      ShortEmailAddressesA contact detail for the individual
                      Comments

                      Implementation of the "EmailAddresses" concept of zib ContactInformation.


                      A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeContactPoint(nl core ContactInformation EmailAddresses)
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      People have (primary) ways to contact them in some way such as phone, email.

                      Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
                      Invariantscpt-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()))
                      124. Patient.telecom:emailAddresses.system
                      Definition

                      Telecommunications form for contact point - what communications system is required to make use of the contact.

                      Shortemailphone | fax | email | pager | url | sms | other
                      Control10..1
                      This element is affected by the following invariants: cpt-2
                      BindingThe 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.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Pattern Valueemail
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      126. Patient.telecom:emailAddresses.use
                      Definition

                      EmailAddressType indicates whether it is a private or business e-mail address.


                      Identifies the purpose for the contact point.

                      ShortEmailAddressTypehome | work | temp | old | mobile - purpose of this contact point
                      Comments

                      Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                      Control0..1
                      BindingThe 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.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                      Alternate NamesEmailSoort
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      128. Patient.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.

                      ShortSpecify 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.

                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      130. Patient.telecom:emailAddresses.period
                      Definition

                      Time period when the contact point was/is in use.

                      ShortTime period when the contact point was/is in use
                      Comments

                      This element is not used in the context of Koppeltaal 2.0

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-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))
                      132. Patient.gender
                      Definition

                      Patient’s administrative gender.


                      Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                      ShortGendermale | female | other | unknown
                      Comments

                      The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                      Control10..1
                      BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
                      (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.


                      The gender of a person used for administrative purposes.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Needed for identification of the individual, in combination with (at least) name and birth date.

                      Alternate NamesGeslacht
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      134. Patient.gender.extension:genderCodelist
                      Slice NamegenderCodelist
                      Definition

                      Optional Extension Element - found in all resources.

                      ShortOptional 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.

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                      Is Modifierfalse
                      Standard StatusNormative (from Normative)
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-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())
                      136. Patient.gender.extension:genderCodelist.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies 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.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                      138. Patient.birthDate
                      Definition

                      Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted.


                      The date of birth for the individual.

                      ShortDateOfBirthThe date of birth for the individual
                      Comments

                      At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                      Control10..1
                      Typedate
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Age of the individual drives many clinical processes.

                      Alternate NamesGeboortedatum
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      140. Patient.deceased[x]
                      Definition

                      Indicates if the individual is deceased or not.

                      ShortIndicates if the individual is deceased or not
                      Comments

                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                      Control0..01
                      This element is affected by the following invariants: ele-1
                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                      Summarytrue
                      Requirements

                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 142. Patient.deceased[x]:deceasedBoolean
                        Slice NamedeceasedBoolean
                        Definition

                        An indication stating whether the patient has died.


                        Indicates if the individual is deceased or not.

                        ShortDeathIndicatorIndicates if the individual is deceased or not
                        Comments

                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                        Control0..01
                        This element is affected by the following invariants: ele-1
                        Typeboolean, dateTime
                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                        Alternate NamesOverlijdensIndicator
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        144. Patient.deceased[x]:deceasedDateTime
                        Slice NamedeceasedDateTime
                        Definition

                        The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.


                        Indicates if the individual is deceased or not.

                        ShortDateOfDeathIndicates if the individual is deceased or not
                        Comments

                        The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.


                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                        Control0..01
                        This element is affected by the following invariants: ele-1
                        TypedateTime, boolean
                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                        Alternate NamesDatumOverlijden, OverlijdensIndicator
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        146. Patient.maritalStatus
                        Definition

                        A person’s marital status according to the terms and definition in the Dutch civil code.


                        This field contains a patient's most recent marital (civil) status.

                        ShortMaritalStatusMarital (civil) status of a patient
                        Comments

                        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

                        Control0..01
                        This element is affected by the following invariants: ele-1
                        BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from BurgerlijkeStaatCodelijsthttp://hl7.org/fhir/ValueSet/marital-status
                        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000)

                        BurgerlijkeStaatCodelijst


                        The domestic partnership status of a person.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Requirements

                        Most, if not all systems capture it.

                        Alternate NamesBurgerlijkeStaat
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        148. Patient.multipleBirth[x]
                        Definition

                        Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                        ShortWhether patient is part of a multiple birth
                        Comments

                        Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                        Control0..01
                        This element is affected by the following invariants: ele-1
                        Typeinteger, boolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Requirements

                        For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 150. Patient.multipleBirth[x]:multipleBirthBoolean
                          Slice NamemultipleBirthBoolean
                          Definition

                          An indication stating whether the patient is of a multiple birth.


                          Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                          ShortMultipleBirthIndicatorWhether patient is part of a multiple birth
                          Comments

                          Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                          Control0..01
                          This element is affected by the following invariants: ele-1
                          Typeboolean, integer
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Requirements

                          For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                          Alternate NamesMeerlingIndicator
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          152. Patient.photo
                          Definition

                          Image of the patient.

                          ShortImage of the patient
                          Comments

                          Guidelines:

                          • Use id photos, not clinical photos.
                          • Limit dimensions to thumbnail.
                          • Keep byte count low to ease resource updates.
                          Control0..0*
                          This element is affected by the following invariants: ele-1
                          TypeAttachment
                          Is Modifierfalse
                          Requirements

                          Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                          Invariantsatt-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()))
                          154. Patient.contact
                          Definition

                          A contact party (e.g. guardian, partner, friend) for the patient.

                          ShortContactA contact party (e.g. guardian, partner, friend) for the patient
                          Comments

                          Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:

                          • The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson.
                          • Information about persons that should be contacted regarding the care for the patient is captured using the Patient.contact resource.

                          If a person is both a related person and a contact person, then some data duplication is inevitable. The nl-core-ContactPerson can be referenced using the extension in contact:contactPerson.


                          Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                          Control0..0*
                          This element is affected by the following invariants: ele-1
                          TypeBackboneElement
                          Is Modifierfalse
                          Requirements

                          Need to track people you can contact about the patient.

                          Alternate NamesContactpersoon
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                          pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                          168. Patient.communication
                          Definition

                          A language which may be used to communicate with the patient about his or her health.

                          ShortLanguageProficiencyA language which may be used to communicate with the patient about his or her health
                          Comments

                          If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                          Control0..0*
                          This element is affected by the following invariants: ele-1
                          TypeBackboneElement
                          Is Modifierfalse
                          Requirements

                          If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                          Alternate NamesTaalvaardigheid
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          187. Patient.generalPractitioner
                          Definition

                          A reference from one resource to another.


                          Patient's nominated care provider.

                          ShortA reference from one resource to anotherPatient's nominated primary care provider
                          Comments

                          Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.

                          In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.


                          This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                          Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                          Control0..0*
                          This element is affected by the following invariants: ele-1
                          TypeReference(Reference)(Organization, Practitioner, PractitionerRole, nl core HealthProfessional PractitionerRole)
                          Is Modifierfalse
                          Alternate NamescareProvider
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                          189. Patient.managingOrganization
                          Definition

                          Organization that is the custodian of the patient record.

                          ShortOrganization that is the custodian of the patient record
                          Comments

                          There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeReference(KT2_Organization, Organization)
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Need to know who recognizes this patient record, manages and updates it.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                          191. Patient.link
                          Definition

                          Link to another patient resource that concerns the same actual patient.

                          ShortLink to another patient resource that concerns the same actual person
                          Comments

                          There is no assumption that linked patient records have mutual links.

                          Control0..0*
                          This element is affected by the following invariants: ele-1
                          TypeBackboneElement
                          Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                          Summarytrue
                          Requirements

                          There are multiple use cases:

                          • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                          • Distribution of patient information across multiple servers.
                          Invariantsele-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. Patient
                          2. Patient.extension:nationality
                          Slice Namenationality
                          Control0..0
                          4. Patient.extension:resource-origin
                          Slice Nameresource-origin
                          Control0..*
                          TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
                          6. Patient.identifier
                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control1..?
                          8. Patient.active
                          Control1..?
                          10. Patient.name
                          Control1..?
                          Invariantskt2pnu-2: Patient name use must not be empty (use.hasValue())
                          12. Patient.name:nameInformation
                          Slice NamenameInformation
                          Comments

                          This .name element represents a Dutch name according to the zib NameInformation (v1.1, 2020) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on .family and on .extension:nameUsage for more information. Systems that need to work in a Dutch context MUST support these extensions as specified here. In addition, systems MUST use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the .text element.

                          Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on .given on how to map the FirstNames and Initials concepts, and on .prefix/.suffix on how to map the Titles concept.

                          Note 2: This element should only contain a person's official names. The GivenName concept is represented in another .name element with .name.use = usual.

                          Note 3: The examples illustrate how the zib is mapped to FHIR.

                          14. Patient.name:nameInformation.text
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          16. Patient.name:nameInformation.family
                          Control1..?
                          18. Patient.name:nameInformation.given
                          Control1..?
                          20. Patient.name:nameInformation.prefix
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          22. Patient.name:nameInformation.suffix
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          24. Patient.name:nameInformation.period
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          26. Patient.name:nameInformation-GivenName
                          Slice NamenameInformation-GivenName
                          28. Patient.name:nameInformation-GivenName.text
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          30. Patient.telecom:telephoneNumbers
                          Slice NametelephoneNumbers
                          32. Patient.telecom:telephoneNumbers.rank
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          34. Patient.telecom:telephoneNumbers.period
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          36. Patient.telecom:emailAddresses
                          Slice NameemailAddresses
                          38. Patient.telecom:emailAddresses.rank
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          40. Patient.telecom:emailAddresses.period
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          42. Patient.gender
                          Control1..?
                          44. Patient.birthDate
                          Control1..?
                          46. Patient.deceased[x]
                          Control0..0
                          48. Patient.deceased[x]:deceasedBoolean
                          Slice NamedeceasedBoolean
                          Control0..0
                          Typeboolean
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          50. Patient.deceased[x]:deceasedDateTime
                          Slice NamedeceasedDateTime
                          Control0..0
                          TypedateTime
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          52. Patient.address
                          54. Patient.address.extension:addressType
                          Slice NameaddressType
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          56. Patient.address.type
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          58. Patient.address.text
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          60. Patient.address.district
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          62. Patient.address.state
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          64. Patient.address.country
                          66. Patient.address.country.extension:countryCode
                          Slice NamecountryCode
                          Comments

                          See Koppeltaal Implementation Guide for more information.

                          68. Patient.address.country.extension:countryCode.extension
                          Control0..0
                          70. Patient.address.country.extension:countryCode.value[x]
                          Comments

                          See Koppeltaal Implementation Guide for more information.

                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          72. Patient.address.period
                          Comments

                          This element is not used in the context of Koppeltaal 2.0

                          74. Patient.maritalStatus
                          Control0..0
                          76. Patient.multipleBirth[x]
                          Control0..0
                          78. Patient.multipleBirth[x]:multipleBirthBoolean
                          Slice NamemultipleBirthBoolean
                          Control0..0
                          Typeboolean
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          80. Patient.photo
                          Control0..0
                          82. Patient.contact
                          Control0..0
                          84. Patient.communication
                          Control0..0
                          86. Patient.generalPractitioner
                          Control0..0
                          88. Patient.managingOrganization
                          TypeReference(KT2_Organization)
                          90. Patient.link
                          Control0..0

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

                          0. Patient
                          Definition

                          Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                          ShortPatient
                          Control0..*
                          Is Modifierfalse
                          Summaryfalse
                          Alternate NamesSubjectOfCare Client Resident, Patient, nl-core-Patient
                          Invariantsdom-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. Patient.id
                          Definition

                          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                          ShortLogical 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.

                          Control0..1
                          Typeid
                          Is Modifierfalse
                          Summarytrue
                          4. Patient.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.

                          ShortMetadata about the resource
                          Control0..1
                          TypeMeta
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          6. Patient.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.

                          ShortA 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.

                          Control0..1
                          Typeuri
                          Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          8. Patient.language
                          Definition

                          The base language in which the resource is written.

                          ShortLanguage 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).

                          Control0..1
                          BindingThe codes SHOULD be taken from CommonLanguages
                          (preferred to http://hl7.org/fhir/ValueSet/languages)

                          A human language.

                          Additional BindingsPurpose
                          AllLanguagesMax Binding
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          10. Patient.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.

                          ShortText 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.

                          Control0..1
                          TypeNarrative
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesnarrative, html, xhtml, display
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          12. Patient.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.

                          ShortContained, 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.

                          Control0..*
                          TypeResource
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesinline resources, anonymous resources, contained resources
                          14. Patient.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.

                          ShortAdditional 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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-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())
                          SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 16. Patient.extension:nationality
                            Slice Namenationality
                            Definition

                            The nationality of the patient.

                            ShortNationality
                            Control0..0
                            This element is affected by the following invariants: ele-1
                            TypeExtension(Patient Nationality) (Complex Extension)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            32. Patient.extension:resource-origin
                            Slice Nameresource-origin
                            Definition

                            Defines the author of the resource.

                            ShortExtension
                            Comments

                            Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it.

                            Control0..1
                            TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-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())
                            34. Patient.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).

                            ShortExtensions 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.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                            Summaryfalse
                            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 Namesextensions, user content
                            Invariantsele-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())
                            SlicingThis element introduces a set of slices on Patient.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 36. Patient.identifier
                              Definition

                              The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example.

                              ShortPatientIdentificationNumber
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control1..*
                              This element is affected by the following invariants: ele-1
                              TypeIdentifier
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Patients are almost always assigned specific numerical identifiers.

                              Alternate NamesIdentificatienummer
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ $this
                              • 38. Patient.identifier:bsn
                                Slice Namebsn
                                Definition

                                An identifier for this patient.

                                ShortAn identifier for this patient
                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..*
                                This element is affected by the following invariants: ele-1
                                TypeIdentifier
                                Is Modifierfalse
                                Standard StatusNormative (from Normative)
                                Summarytrue
                                Requirements

                                Patients are almost always assigned specific numerical identifiers.

                                Pattern Value{
                                  "system" : "http://fhir.nl/fhir/NamingSystem/bsn"
                                }
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                40. Patient.active
                                Definition

                                Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                It is often used to filter patient lists to exclude inactive patients

                                Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                ShortWhether this patient's record is in active use
                                Comments

                                If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                Control1..1
                                Typeboolean
                                Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to be able to mark a patient record as not to be used because it was created in error.

                                Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                42. Patient.name
                                Definition

                                Patient's full name.

                                ShortNameInformation / PayerName
                                Comments

                                A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                Control1..*
                                This element is affected by the following invariants: ele-1
                                TypeHumanName
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                Alternate NamesNaamgegevens, BetalerNaam
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                kt2pnu-2: Patient name use must not be empty (use.hasValue())
                                SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ use
                                • 44. Patient.name:nameInformation
                                  Slice NamenameInformation
                                  Definition

                                  This slice represents the person's official name information, including given names, last name and possibly the partner's last name.

                                  ShortNameInformation
                                  Comments

                                  This .name element represents a Dutch name according to the zib NameInformation (v1.1, 2020) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on .family and on .extension:nameUsage for more information. Systems that need to work in a Dutch context MUST support these extensions as specified here. In addition, systems MUST use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the .text element.

                                  Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on .given on how to map the FirstNames and Initials concepts, and on .prefix/.suffix on how to map the Titles concept.

                                  Note 2: This element should only contain a person's official names. The GivenName concept is represented in another .name element with .name.use = usual.

                                  Note 3: The examples illustrate how the zib is mapped to FHIR.

                                  Control0..2
                                  This element is affected by the following invariants: ele-1
                                  TypeHumanName(nl core NameInformation)
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                  Alternate NamesNaamgegevens, nl-core-NameInformation
                                  Invariantsele-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())
                                  46. Patient.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.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  48. Patient.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.

                                  ShortAdditional 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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-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())
                                  SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 50. Patient.name:nameInformation.extension:nameUsage
                                    Slice NamenameUsage
                                    Definition

                                    A code that represents the preferred display order of the components of this human name.

                                    ShortPreferred display order of name parts
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(Assembly Order) (Extension Type: code)
                                    Is Modifierfalse
                                    Standard StatusNormative (from Normative)
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-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())
                                    52. Patient.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.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    54. Patient.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.

                                    ShortAdditional 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.

                                    Control0..0
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-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())
                                    SlicingThis element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 56. Patient.name:nameInformation.extension:nameUsage.url
                                      Definition

                                      Source of the definition for the extension code - a logical name or a URL.

                                      Shortidentifies 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.

                                      Control1..1
                                      Typeuri
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order
                                      58. Patient.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.

                                      ShortNameUsage
                                      Control1..1
                                      BindingThe 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.

                                      Typecode
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Alternate NamesNaamgebruik
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      60. Patient.name:nameInformation.use
                                      Definition

                                      Identifies the purpose for this name.

                                      Shortusual | 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.

                                      Control1..1
                                      BindingThe codes SHALL be taken from NameUse
                                      (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                      The use of a human name.

                                      Typecode
                                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                      Pattern Valueofficial
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      62. Patient.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.

                                      ShortText representation of the full name
                                      Comments

                                      This element is not used in the context of Koppeltaal 2.0

                                      Control0..1
                                      This element is affected by the following invariants: nl-core-NameInformation-01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      A renderable, unencoded form.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      64. Patient.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.

                                      ShortFamily 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.

                                      Control1..1
                                      This element is affected by the following invariants: nl-core-NameInformation-01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Alternate Namessurname
                                      Invariantsele-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())
                                      66. Patient.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.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      68. Patient.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.

                                      ShortAdditional 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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-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())
                                      SlicingThis element introduces a set of slices on Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 70. Patient.name:nameInformation.family.extension:prefix
                                        Slice Nameprefix
                                        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.

                                        ShortVoorvoegsel 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.

                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Own Prefix) (Extension Type: string)
                                        Is Modifierfalse
                                        Standard StatusNormative (from Normative)
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-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())
                                        72. Patient.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.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        74. Patient.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.

                                        ShortAdditional 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.

                                        Control0..0
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-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())
                                        SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 76. Patient.name:nameInformation.family.extension:prefix.url
                                          Definition

                                          Source of the definition for the extension code - a logical name or a URL.

                                          Shortidentifies 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.

                                          Control1..1
                                          Typeuri
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix
                                          78. Patient.name:nameInformation.family.extension:prefix.value[x]
                                          Definition

                                          Prefix to the person’s own last name.

                                          ShortPrefix
                                          Control1..1
                                          Typestring
                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summaryfalse
                                          Alternate NamesVoorvoegsels
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          80. Patient.name:nameInformation.family.extension:lastName
                                          Slice NamelastName
                                          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.

                                          ShortPortion 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".

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Own Name) (Extension Type: string)
                                          Is Modifierfalse
                                          Standard StatusNormative (from Normative)
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-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())
                                          82. Patient.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.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          84. Patient.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.

                                          ShortAdditional 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.

                                          Control0..0
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-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())
                                          SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 86. Patient.name:nameInformation.family.extension:lastName.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies 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.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-name
                                            88. Patient.name:nameInformation.family.extension:lastName.value[x]
                                            Definition

                                            The person’s official last name

                                            ShortLastName
                                            Control1..1
                                            Typestring
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Alternate NamesAchternaam
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            90. Patient.name:nameInformation.family.extension:partnerPrefix
                                            Slice NamepartnerPrefix
                                            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.

                                            ShortVoorvoegsel 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.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Partner Prefix) (Extension Type: string)
                                            Is Modifierfalse
                                            Standard StatusNormative (from Normative)
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-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())
                                            92. Patient.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.

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            94. Patient.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.

                                            ShortAdditional 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.

                                            Control0..0
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-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())
                                            SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 96. Patient.name:nameInformation.family.extension:partnerPrefix.url
                                              Definition

                                              Source of the definition for the extension code - a logical name or a URL.

                                              Shortidentifies 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.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
                                              98. Patient.name:nameInformation.family.extension:partnerPrefix.value[x]
                                              Definition

                                              Prefix to the partner’s last name.

                                              ShortPartnerPrefix
                                              Control1..1
                                              Typestring
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summaryfalse
                                              Alternate NamesVoorvoegselsPartner
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              100. Patient.name:nameInformation.family.extension:partnerLastName
                                              Slice NamepartnerLastName
                                              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.

                                              ShortPortion 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".

                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Partner Name) (Extension Type: string)
                                              Is Modifierfalse
                                              Standard StatusNormative (from Normative)
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-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())
                                              102. Patient.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.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              104. Patient.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.

                                              ShortAdditional 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.

                                              Control0..0
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-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())
                                              SlicingThis element introduces a set of slices on Patient.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 106. Patient.name:nameInformation.family.extension:partnerLastName.url
                                                Definition

                                                Source of the definition for the extension code - a logical name or a URL.

                                                Shortidentifies 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.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-name
                                                108. Patient.name:nameInformation.family.extension:partnerLastName.value[x]
                                                Definition

                                                Partner’s official last name.

                                                ShortPartnerLastName
                                                Control1..1
                                                Typestring
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Alternate NamesAchternaamPartner
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                110. Patient.name:nameInformation.family.value
                                                Definition

                                                Primitive value for string

                                                ShortPrimitive value for string
                                                Control0..1
                                                Typestring
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Max Length:1048576
                                                112. Patient.name:nameInformation.given
                                                Definition

                                                One of a person’s official first names or the initial if the full name is not known.

                                                ShortFirstName / Initial
                                                Comments

                                                This element can be used to represent full given names or initials. extension:givenOrInitial SHALL be used on each repretition to specifiy if it's a full name (BR) or an initial (IN).

                                                Zib compatibility

                                                Tthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.

                                                Therefore, the zib concepts are implemented here in the following way:

                                                • Systems SHOULD use a .given element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).
                                                • Each of these elements:
                                                  • SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.
                                                  • As noted, it SHALL be augmented with extension:givenOrInitial.

                                                Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.

                                                If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional .name instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.

                                                Note 1: The GivenName concept should not be included here but in a separate .name instance where .use = usual.

                                                Note 2: As specified by FHIR, multiple official first names MAY be combined in a single .given element (separated by spaces), as long as the .given elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.

                                                Control1..*
                                                This element is affected by the following invariants: nl-core-NameInformation-01
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Alternate Namesfirst name, middle name, Voornaam, Initiaal
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                114. Patient.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                116. Patient.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.

                                                ShortAdditional 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.

                                                Control1..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-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())
                                                SlicingThis element introduces a set of slices on Patient.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 118. Patient.name:nameInformation.given.extension:givenOrInitial
                                                  Slice NamegivenOrInitial
                                                  Definition

                                                  A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

                                                  ShortLS | 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.

                                                  Control1..*
                                                  This element is affected by the following invariants: ele-1
                                                  TypeExtension(EN Qualifier) (Extension Type: code)
                                                  Is Modifierfalse
                                                  Standard StatusNormative (from Normative)
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-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())
                                                  120. Patient.name:nameInformation.given.value
                                                  Definition

                                                  Primitive value for string

                                                  ShortPrimitive value for string
                                                  Control0..1
                                                  Typestring
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Max Length:1048576
                                                  122. Patient.name:nameInformation.prefix
                                                  Definition

                                                  Noble and scientific titles. These can assist in formulating oral and formal addresing titles.

                                                  ShortTitles
                                                  Comments

                                                  This element is not used in the context of Koppeltaal 2.0

                                                  Control0..*
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Alternate NamesTitels
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  124. Patient.name:nameInformation.suffix
                                                  Definition

                                                  Noble and scientific titles. These can assist in formulating oral and formal addresing titles.

                                                  ShortTitles
                                                  Comments

                                                  This element is not used in the context of Koppeltaal 2.0

                                                  Control0..*
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Alternate NamesTitels
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  126. Patient.name:nameInformation.period
                                                  Definition

                                                  Indicates the period of time when this name was valid for the named person.

                                                  ShortTime period when name was/is in use
                                                  Comments

                                                  This element is not used in the context of Koppeltaal 2.0

                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  TypePeriod
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Allows names to be placed in historical context.

                                                  Invariantsele-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))
                                                  128. Patient.name:nameInformation-GivenName
                                                  Slice NamenameInformation-GivenName
                                                  Definition

                                                  This slice represents the name information normally used to address the person.

                                                  ShortName of a human - parts and usage
                                                  Comments

                                                  This .name element represents the Dutch given name ("roepnaam") according to the zib NameInformation v1.1 (2020).

                                                  Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other .name elements with .name.use = official.

                                                  Note 2: The examples illustrate how the zib is mapped to FHIR.

                                                  Control0..*
                                                  This element is affected by the following invariants: ele-1
                                                  TypeHumanName(nl core NameInformation.GivenName)
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                  Alternate Namesnl-core-NameInformation.GivenName
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  130. Patient.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.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  132. Patient.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.

                                                  ShortAdditional 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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-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())
                                                  SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 134. Patient.name:nameInformation-GivenName.use
                                                    Definition

                                                    Identifies the purpose for this name.

                                                    Shortusual | 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.

                                                    Control1..1
                                                    BindingThe codes SHALL be taken from NameUse
                                                    (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                    The use of a human name.

                                                    Typecode
                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                    Pattern Valueusual
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    136. Patient.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.

                                                    ShortText representation of the full name
                                                    Comments

                                                    This element is not used in the context of Koppeltaal 2.0

                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    A renderable, unencoded form.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    138. Patient.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.

                                                    ShortFamily name (often called 'Surname')
                                                    Comments

                                                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                    Control0..0
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Alternate Namessurname
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    140. Patient.name:nameInformation-GivenName.given
                                                    Definition

                                                    The name normally used to address the person.

                                                    ShortGivenName
                                                    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.

                                                    Control1..*
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Alternate Namesfirst name, middle name, Roepnaam
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    142. Patient.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.

                                                    ShortParts that come before the name
                                                    Comments

                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                    Control0..0
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    144. Patient.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.

                                                    ShortParts that come after the name
                                                    Comments

                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                    Control0..0
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    146. Patient.name:nameInformation-GivenName.period
                                                    Definition

                                                    Indicates the period of time when this name was valid for the named person.

                                                    ShortTime period when name was/is in use
                                                    Comments

                                                    A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                    Period is not used for a duration (a measure of elapsed time). See Duration.

                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypePeriod
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

                                                    Allows names to be placed in historical context.

                                                    Invariantsele-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))
                                                    148. Patient.telecom
                                                    Definition

                                                    Patient’s telephone number(s) or e-mail address(es).

                                                    ShortContactInformation
                                                    Comments

                                                    The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.

                                                    Control0..*
                                                    This element is affected by the following invariants: ele-1
                                                    TypeContactPoint
                                                    Is Modifierfalse
                                                    Standard StatusNormative (from Normative)
                                                    Summarytrue
                                                    Requirements

                                                    People have (primary) ways to contact them in some way such as phone, email.

                                                    Alternate NamesContactgegevens
                                                    Invariantscpt-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()))
                                                    SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • profile @ $this
                                                    • 150. Patient.telecom:telephoneNumbers
                                                      Slice NametelephoneNumbers
                                                      Definition

                                                      Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                      ShortTelephoneNumbers
                                                      Comments

                                                      Implementation of the "TelephoneNumbers" concept of zib ContactInformation.

                                                      Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts ContactPoint.system and ContactPoint.use respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on ContactPoint.system is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.

                                                      Control0..*
                                                      This element is affected by the following invariants: ele-1
                                                      TypeContactPoint(nl core ContactInformation TelephoneNumbers)
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Requirements

                                                      People have (primary) ways to contact them in some way such as phone, email.

                                                      Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
                                                      Invariantscpt-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()))
                                                      152. Patient.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.

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      154. Patient.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.

                                                      ShortAdditional 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.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-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())
                                                      SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 156. Patient.telecom:telephoneNumbers.extension:comment
                                                        Slice Namecomment
                                                        Definition

                                                        Optional Extension Element - found in all resources.

                                                        ShortOptional 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.

                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(ext Comment) (Extension Type: string)
                                                        Is Modifierfalse
                                                        Standard StatusNormative (from Normative)
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-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())
                                                        158. Patient.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.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        160. Patient.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.

                                                        ShortAdditional 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.

                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-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())
                                                        SlicingThis element introduces a set of slices on Patient.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 162. Patient.telecom:telephoneNumbers.extension:comment.url
                                                          Definition

                                                          Source of the definition for the extension code - a logical name or a URL.

                                                          Shortidentifies 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.

                                                          Control1..1
                                                          Typeuri
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-Comment
                                                          164. Patient.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.

                                                          ShortComment
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typestring
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Standard StatusNormative (from Normative)
                                                          Alternate NamesToelichting
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          166. Patient.telecom:telephoneNumbers.system
                                                          Definition

                                                          The telecom or device type that the telephone number is connected to.

                                                          ShortTelecomType
                                                          Control1..1
                                                          This element is affected by the following invariants: cpt-2
                                                          BindingThe 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.

                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Alternate NamesTelecomType
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          168. Patient.telecom:telephoneNumbers.system.id
                                                          Definition

                                                          unique id for the element within a resource (for internal references)

                                                          Shortxml:id (or equivalent in JSON)
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          170. Patient.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.

                                                          ShortAdditional 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.

                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Alternate Namesextensions, user content
                                                          Invariantsele-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())
                                                          SlicingThis element introduces a set of slices on Patient.telecom.system.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 172. Patient.telecom:telephoneNumbers.system.extension:telecomType
                                                            Slice NametelecomType
                                                            Definition

                                                            Optional Extension Element - found in all resources.

                                                            ShortOptional 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.

                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                                                            Is Modifierfalse
                                                            Standard StatusNormative (from Normative)
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-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())
                                                            174. Patient.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.

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            176. Patient.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.

                                                            ShortAdditional 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.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-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())
                                                            SlicingThis element introduces a set of slices on Patient.telecom.system.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 178. Patient.telecom:telephoneNumbers.system.extension:telecomType.url
                                                              Definition

                                                              Source of the definition for the extension code - a logical name or a URL.

                                                              Shortidentifies 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.

                                                              Control1..1
                                                              Typeuri
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                                              180. Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x]
                                                              Definition

                                                              The telecom or device type that the telephone number is connected to.

                                                              ShortTelecomType
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              BindingThe 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)
                                                              TypeCodeableConcept
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              Is Modifierfalse
                                                              Standard StatusNormative (from Normative)
                                                              Alternate NamesTelecomType
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              182. Patient.telecom:telephoneNumbers.system.value
                                                              Definition

                                                              Primitive value for code

                                                              ShortPrimitive value for code
                                                              Control0..1
                                                              Typecode
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              Max Length:1048576
                                                              184. Patient.telecom:telephoneNumbers.value
                                                              Definition

                                                              The person's telephone number.

                                                              ShortTelephoneNumber
                                                              Comments

                                                              Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to support legacy numbers that are not in a tightly controlled format.

                                                              Alternate NamesTelefoonnummer
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              186. Patient.telecom:telephoneNumbers.use
                                                              Definition

                                                              NumberType indicates whether the number is a landline, temporary, work telephone number.

                                                              ShortNumberType
                                                              Comments

                                                              Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                              Control0..1
                                                              BindingThe 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.

                                                              Typecode
                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                              Alternate NamesNummerSoort
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              188. Patient.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.

                                                              ShortSpecify preferred order of use (1 = highest)
                                                              Comments

                                                              This element is not used in the context of Koppeltaal 2.0

                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              190. Patient.telecom:telephoneNumbers.period
                                                              Definition

                                                              Time period when the contact point was/is in use.

                                                              ShortTime period when the contact point was/is in use
                                                              Comments

                                                              This element is not used in the context of Koppeltaal 2.0

                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-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))
                                                              192. Patient.telecom:emailAddresses
                                                              Slice NameemailAddresses
                                                              Definition

                                                              Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                              ShortEmailAddresses
                                                              Comments

                                                              Implementation of the "EmailAddresses" concept of zib ContactInformation.

                                                              Control0..*
                                                              This element is affected by the following invariants: ele-1
                                                              TypeContactPoint(nl core ContactInformation EmailAddresses)
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Requirements

                                                              People have (primary) ways to contact them in some way such as phone, email.

                                                              Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
                                                              Invariantscpt-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()))
                                                              194. Patient.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.

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              196. Patient.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.

                                                              ShortAdditional 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.

                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Alternate Namesextensions, user content
                                                              Invariantsele-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())
                                                              SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 198. Patient.telecom:emailAddresses.system
                                                                Definition

                                                                Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                Shortemail
                                                                Control1..1
                                                                This element is affected by the following invariants: cpt-2
                                                                BindingThe codes SHALL be taken from ContactPointSystem
                                                                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                Telecommunications form for contact point.

                                                                Typecode
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Pattern Valueemail
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                200. Patient.telecom:emailAddresses.value
                                                                Definition

                                                                The person's e-mail address

                                                                ShortEmailAddress
                                                                Comments

                                                                Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Need to support legacy numbers that are not in a tightly controlled format.

                                                                Alternate NamesEmailAdres
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                202. Patient.telecom:emailAddresses.use
                                                                Definition

                                                                EmailAddressType indicates whether it is a private or business e-mail address.

                                                                ShortEmailAddressType
                                                                Comments

                                                                Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                Control0..1
                                                                BindingThe 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.

                                                                Typecode
                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                Alternate NamesEmailSoort
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                204. Patient.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.

                                                                ShortSpecify preferred order of use (1 = highest)
                                                                Comments

                                                                This element is not used in the context of Koppeltaal 2.0

                                                                Control0..1
                                                                TypepositiveInt
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                206. Patient.telecom:emailAddresses.period
                                                                Definition

                                                                Time period when the contact point was/is in use.

                                                                ShortTime period when the contact point was/is in use
                                                                Comments

                                                                This element is not used in the context of Koppeltaal 2.0

                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                TypePeriod
                                                                Is Modifierfalse
                                                                Summarytrue
                                                                Invariantsele-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))
                                                                208. Patient.gender
                                                                Definition

                                                                Patient’s administrative gender.

                                                                ShortGender
                                                                Comments

                                                                The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                                Control1..1
                                                                BindingThe 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.

                                                                Typecode
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Needed for identification of the individual, in combination with (at least) name and birth date.

                                                                Alternate NamesGeslacht
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                210. Patient.gender.id
                                                                Definition

                                                                unique id for the element within a resource (for internal references)

                                                                Shortxml:id (or equivalent in JSON)
                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                212. Patient.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.

                                                                ShortAdditional 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.

                                                                Control0..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Alternate Namesextensions, user content
                                                                Invariantsele-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())
                                                                SlicingThis element introduces a set of slices on Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 214. Patient.gender.extension:genderCodelist
                                                                  Slice NamegenderCodelist
                                                                  Definition

                                                                  Optional Extension Element - found in all resources.

                                                                  ShortOptional 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.

                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                                                                  Is Modifierfalse
                                                                  Standard StatusNormative (from Normative)
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-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())
                                                                  216. Patient.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.

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  218. Patient.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.

                                                                  ShortAdditional 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.

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-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())
                                                                  SlicingThis element introduces a set of slices on Patient.gender.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 220. Patient.gender.extension:genderCodelist.url
                                                                    Definition

                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                    Shortidentifies 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.

                                                                    Control1..1
                                                                    Typeuri
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                                                    222. Patient.gender.extension:genderCodelist.value[x]
                                                                    Definition

                                                                    Patient’s administrative gender.

                                                                    ShortGender
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    BindingThe 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.0.1.1--20200901000000)

                                                                    GeslachtCodelijst

                                                                    TypeCodeableConcept
                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                    Is Modifierfalse
                                                                    Standard StatusNormative (from Normative)
                                                                    Alternate NamesGeslacht
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    224. Patient.gender.value
                                                                    Definition

                                                                    Primitive value for code

                                                                    ShortPrimitive value for code
                                                                    Control0..1
                                                                    Typecode
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    Max Length:1048576
                                                                    226. Patient.birthDate
                                                                    Definition

                                                                    Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted.

                                                                    ShortDateOfBirth
                                                                    Comments

                                                                    At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                                    Control1..1
                                                                    Typedate
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Requirements

                                                                    Age of the individual drives many clinical processes.

                                                                    Alternate NamesGeboortedatum
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    228. Patient.deceased[x]
                                                                    Definition

                                                                    Indicates if the individual is deceased or not.

                                                                    ShortIndicates if the individual is deceased or not
                                                                    Comments

                                                                    If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                    Control0..0
                                                                    This element is affected by the following invariants: ele-1
                                                                    Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                    Summarytrue
                                                                    Requirements

                                                                    The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                    • type @ $this
                                                                    • 230. Patient.deceased[x]:deceasedBoolean
                                                                      Slice NamedeceasedBoolean
                                                                      Definition

                                                                      An indication stating whether the patient has died.

                                                                      ShortDeathIndicator
                                                                      Comments

                                                                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                      Control0..0
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typeboolean
                                                                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Requirements

                                                                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                      Alternate NamesOverlijdensIndicator
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      232. Patient.deceased[x]:deceasedDateTime
                                                                      Slice NamedeceasedDateTime
                                                                      Definition

                                                                      The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.

                                                                      ShortDateOfDeath
                                                                      Comments

                                                                      The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.

                                                                      Control0..0
                                                                      This element is affected by the following invariants: ele-1
                                                                      TypedateTime
                                                                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Requirements

                                                                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                      Alternate NamesDatumOverlijden, OverlijdensIndicator
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      234. Patient.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.

                                                                      ShortAddressInformation
                                                                      Comments

                                                                      This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the zib AddressInformation v1.1 (2020). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.

                                                                      To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.

                                                                      Separate address parts

                                                                      The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.

                                                                      Custom address types

                                                                      The second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The code from the zib should also be included using the extension on Address.extension:addressType.

                                                                      zib .ext:addressType .use .type
                                                                      Postal Address/Postadres PST postal
                                                                      Primary Home/Officieel adres HP home both
                                                                      Visit Address/Woon-/verblijfadres PHYS home physical
                                                                      Temporary Address/Tijdelijk adres TMP temp
                                                                      Work Place/Werkadres WP work
                                                                      Vacation Home/Vakantie adres HV temp

                                                                      If Address.type is both then this is to be understood as a dual purpose address (postal and physical), unless a specific postal type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.

                                                                      Note: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.

                                                                      Control0..*
                                                                      This element is affected by the following invariants: ele-1
                                                                      TypeAddress(nl core AddressInformation)
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                                      Alternate NamesAdresgegevens, nl-core-AddressInformation
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      236. Patient.address.id
                                                                      Definition

                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      238. Patient.address.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.

                                                                      ShortAdditional 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.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-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())
                                                                      SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 240. Patient.address.extension:addressType
                                                                        Slice NameaddressType
                                                                        Definition

                                                                        Optional Extension Element - found in all resources.

                                                                        ShortOptional Extensions Element
                                                                        Comments

                                                                        This element is not used in the context of Koppeltaal 2.0

                                                                        Control0..1
                                                                        This element is affected by the following invariants: ele-1
                                                                        TypeExtension(ext AddressInformation.AddressType) (Extension Type: CodeableConcept)
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-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())
                                                                        242. Patient.address.use
                                                                        Definition

                                                                        The type of address in question, such as a home address or mailing address.

                                                                        ShortAddressType
                                                                        Comments

                                                                        Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                        Control0..1
                                                                        BindingThe codes SHALL be taken from AddressUse
                                                                        (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                        Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.

                                                                        Typecode
                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows an appropriate address to be chosen from a list of many.

                                                                        Alternate NamesAdresSoort
                                                                        Example<br/><b>General</b>:home
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        244. Patient.address.type
                                                                        Definition

                                                                        The type of address in question, such as a home address or mailing address.

                                                                        ShortAddressType
                                                                        Comments

                                                                        This element is not used in the context of Koppeltaal 2.0

                                                                        Control0..1
                                                                        BindingThe codes SHALL be taken from AddressType
                                                                        (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                        Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.

                                                                        Typecode
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Alternate NamesAdresSoort
                                                                        Example<br/><b>General</b>:both
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        246. Patient.address.text
                                                                        Definition

                                                                        Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                        ShortText representation of the address
                                                                        Comments

                                                                        This element is not used in the context of Koppeltaal 2.0

                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Requirements

                                                                        A renderable, unencoded form.

                                                                        Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        248. Patient.address.line
                                                                        Definition

                                                                        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                        ShortStreet name, number, direction & P.O. Box etc.
                                                                        Comments

                                                                        The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in.

                                                                        The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the Address.line to which they are attached. The value of Address.line should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]".

                                                                        Control0..*
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Example<br/><b>General</b>:137 Nowhere Street
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        250. Patient.address.line.id
                                                                        Definition

                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        252. Patient.address.line.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.

                                                                        ShortAdditional 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.

                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Alternate Namesextensions, user content
                                                                        Invariantsele-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())
                                                                        SlicingThis element introduces a set of slices on Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 254. Patient.address.line.extension:streetName
                                                                          Slice NamestreetName
                                                                          Definition

                                                                          streetName.

                                                                          ShortstreetName
                                                                          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.

                                                                          Control0..1
                                                                          This element is affected by the following invariants: ele-1
                                                                          TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                          Is Modifierfalse
                                                                          Standard StatusNormative (from Normative)
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-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())
                                                                          256. Patient.address.line.extension:streetName.id
                                                                          Definition

                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          258. Patient.address.line.extension:streetName.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.

                                                                          ShortAdditional 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.

                                                                          Control0..0
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-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())
                                                                          SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 260. Patient.address.line.extension:streetName.url
                                                                            Definition

                                                                            Source of the definition for the extension code - a logical name or a URL.

                                                                            Shortidentifies 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.

                                                                            Control1..1
                                                                            Typeuri
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
                                                                            262. Patient.address.line.extension:streetName.value[x]
                                                                            Definition

                                                                            Street name of the address.

                                                                            ShortStreet
                                                                            Control1..1
                                                                            Typestring
                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summaryfalse
                                                                            Alternate NamesStraat
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            264. Patient.address.line.extension:houseNumber
                                                                            Slice NamehouseNumber
                                                                            Definition

                                                                            The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                                            ShorthouseNumber
                                                                            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.

                                                                            Control0..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            TypeExtension(ADXP House Number) (Extension Type: string)
                                                                            Is Modifierfalse
                                                                            Standard StatusNormative (from Normative)
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-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())
                                                                            266. Patient.address.line.extension:houseNumber.id
                                                                            Definition

                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            268. Patient.address.line.extension:houseNumber.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.

                                                                            ShortAdditional 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.

                                                                            Control0..0
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-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())
                                                                            SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 270. Patient.address.line.extension:houseNumber.url
                                                                              Definition

                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                              Shortidentifies 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.

                                                                              Control1..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
                                                                              272. Patient.address.line.extension:houseNumber.value[x]
                                                                              Definition

                                                                              House number of the address.

                                                                              ShortHouseNumber
                                                                              Control1..1
                                                                              Typestring
                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summaryfalse
                                                                              Alternate NamesHuisnummer
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              274. Patient.address.line.extension:houseNumberLetter-houseNumberAddition
                                                                              Slice NamehouseNumberLetter-houseNumberAddition
                                                                              Definition

                                                                              Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number.

                                                                              ShortbuildingNumberSuffix
                                                                              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.

                                                                              Control0..1
                                                                              This element is affected by the following invariants: ele-1
                                                                              TypeExtension(ADXP Building Number Suffix) (Extension Type: string)
                                                                              Is Modifierfalse
                                                                              Standard StatusNormative (from Normative)
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-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())
                                                                              276. Patient.address.line.extension:houseNumberLetter-houseNumberAddition.id
                                                                              Definition

                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              278. Patient.address.line.extension:houseNumberLetter-houseNumberAddition.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.

                                                                              ShortAdditional 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.

                                                                              Control0..0
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-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())
                                                                              SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 280. Patient.address.line.extension:houseNumberLetter-houseNumberAddition.url
                                                                                Definition

                                                                                Source of the definition for the extension code - a logical name or a URL.

                                                                                Shortidentifies 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.

                                                                                Control1..1
                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
                                                                                282. Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x]
                                                                                Definition

                                                                                Export:

                                                                                • If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition.
                                                                                • If only a HouseNumberLetter is known, send just that. No trailing space is required.
                                                                                • If only a HouseNumberAddition is known, communicate that with a leading space.

                                                                                Import

                                                                                • If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter.
                                                                                • If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition.

                                                                                Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.

                                                                                ShortHouseNumberLetter / HouseNumberAddition
                                                                                Control1..1
                                                                                Typestring
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summaryfalse
                                                                                Alternate NamesHuisnummerletter, Huisnummertoevoeging
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                284. Patient.address.line.extension:houseNumberIndication
                                                                                Slice NamehouseNumberIndication
                                                                                Definition

                                                                                This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

                                                                                ShortadditionalLocator
                                                                                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.

                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                                Is Modifierfalse
                                                                                Standard StatusNormative (from Normative)
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-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())
                                                                                286. Patient.address.line.extension:houseNumberIndication.id
                                                                                Definition

                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                288. Patient.address.line.extension:houseNumberIndication.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.

                                                                                ShortAdditional 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.

                                                                                Control0..0
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-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())
                                                                                SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 290. Patient.address.line.extension:houseNumberIndication.url
                                                                                  Definition

                                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                                  Shortidentifies 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.

                                                                                  Control1..1
                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
                                                                                  292. Patient.address.line.extension:houseNumberIndication.value[x]
                                                                                  Definition

                                                                                  The indication used for addresses which do not consist of the usual street name and house number.

                                                                                  ShortHouseNumberIndication
                                                                                  Comments

                                                                                  The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. As a result of this, the coded zib HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').

                                                                                  Control1..1
                                                                                  Typestring
                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summaryfalse
                                                                                  Alternate NamesAanduidingBijNummer
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  houseNumberIndication: Must have value 'by' or 'to' ($this in ('by' | 'to'))
                                                                                  294. Patient.address.line.extension:additionalInformation
                                                                                  Slice NameadditionalInformation
                                                                                  Definition

                                                                                  The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

                                                                                  ShortunitID
                                                                                  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.

                                                                                  Control0..1
                                                                                  This element is affected by the following invariants: ele-1
                                                                                  TypeExtension(ADXP Unit ID) (Extension Type: string)
                                                                                  Is Modifierfalse
                                                                                  Standard StatusNormative (from Normative)
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-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())
                                                                                  296. Patient.address.line.extension:additionalInformation.id
                                                                                  Definition

                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  298. Patient.address.line.extension:additionalInformation.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.

                                                                                  ShortAdditional 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.

                                                                                  Control0..0
                                                                                  TypeExtension
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-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())
                                                                                  SlicingThis element introduces a set of slices on Patient.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 300. Patient.address.line.extension:additionalInformation.url
                                                                                    Definition

                                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                                    Shortidentifies 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.

                                                                                    Control1..1
                                                                                    Typeuri
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
                                                                                    302. Patient.address.line.extension:additionalInformation.value[x]
                                                                                    Definition

                                                                                    Extra information such as the building name, building number, entrance, route number.

                                                                                    ShortAdditionalInformation
                                                                                    Control1..1
                                                                                    Typestring
                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summaryfalse
                                                                                    Alternate NamesAdditioneleInformatie
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    304. Patient.address.line.value
                                                                                    Definition

                                                                                    Primitive value for string

                                                                                    ShortPrimitive value for string
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Max Length:1048576
                                                                                    306. Patient.address.city
                                                                                    Definition

                                                                                    A geographically determined area which forms part of the municipal area. For Dutch places of residence, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).

                                                                                    ShortPlaceOfResidence
                                                                                    Comments

                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Alternate NamesMunicpality, Woonplaats
                                                                                    Example<br/><b>General</b>:Erewhon
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    308. Patient.address.district
                                                                                    Definition

                                                                                    Municipality of residence. For Dutch municipalities, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).

                                                                                    ShortMunicipality
                                                                                    Comments

                                                                                    This element is not used in the context of Koppeltaal 2.0

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Alternate NamesCounty, Gemeente
                                                                                    Example<br/><b>General</b>:Madison
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    310. Patient.address.state
                                                                                    Definition

                                                                                    Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                                    ShortSub-unit of country (abbreviations ok)
                                                                                    Comments

                                                                                    This element is not used in the context of Koppeltaal 2.0

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Alternate NamesProvince, Territory
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    312. Patient.address.postalCode
                                                                                    Definition

                                                                                    Postcode of the address. In Dutch addresses, preferably use the postcode from the Postcode table (OID: 2.16.840.1.113883.2.4.4.15).

                                                                                    ShortPostcode
                                                                                    Comments

                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Alternate NamesZip, Postcode
                                                                                    Example<br/><b>General</b>:9132
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    314. Patient.address.country
                                                                                    Definition

                                                                                    Country - a nation as commonly understood or generally accepted.

                                                                                    ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                                                    Comments

                                                                                    The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the ext-CodeSpecification extension under Address.country.extension:countryCode.

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    316. Patient.address.country.id
                                                                                    Definition

                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    318. Patient.address.country.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.

                                                                                    ShortAdditional 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.

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-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())
                                                                                    SlicingThis element introduces a set of slices on Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 320. Patient.address.country.extension:countryCode
                                                                                      Slice NamecountryCode
                                                                                      Definition

                                                                                      Optional Extension Element - found in all resources.

                                                                                      ShortOptional Extensions Element
                                                                                      Comments

                                                                                      See Koppeltaal Implementation Guide for more information.

                                                                                      Control0..1
                                                                                      This element is affected by the following invariants: ele-1
                                                                                      TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-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())
                                                                                      322. Patient.address.country.extension:countryCode.id
                                                                                      Definition

                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      324. Patient.address.country.extension:countryCode.extension
                                                                                      Definition

                                                                                      An Extension

                                                                                      ShortExtension
                                                                                      Control0..0
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-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())
                                                                                      SlicingThis element introduces a set of slices on Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 326. Patient.address.country.extension:countryCode.url
                                                                                        Definition

                                                                                        Source of the definition for the extension code - a logical name or a URL.

                                                                                        Shortidentifies 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.

                                                                                        Control1..1
                                                                                        Typeuri
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                                                                        328. Patient.address.country.extension:countryCode.value[x]
                                                                                        Definition

                                                                                        Country in which the address is located.

                                                                                        ShortCountry
                                                                                        Comments

                                                                                        See Koppeltaal Implementation Guide for more information.

                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        BindingThe codes SHALL be taken from LandCodelijsten
                                                                                        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000)
                                                                                        TypeCodeableConcept
                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                        Is Modifierfalse
                                                                                        Alternate NamesLand
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        330. Patient.address.country.value
                                                                                        Definition

                                                                                        Primitive value for string

                                                                                        ShortPrimitive value for string
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Max Length:1048576
                                                                                        332. Patient.address.period
                                                                                        Definition

                                                                                        Time period when address was/is in use.

                                                                                        ShortTime period when address was/is in use
                                                                                        Comments

                                                                                        This element is not used in the context of Koppeltaal 2.0

                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        TypePeriod
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Allows addresses to be placed in historical context.

                                                                                        Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                        Invariantsele-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))
                                                                                        334. Patient.maritalStatus
                                                                                        Definition

                                                                                        A person’s marital status according to the terms and definition in the Dutch civil code.

                                                                                        ShortMaritalStatus
                                                                                        Comments

                                                                                        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

                                                                                        Control0..0
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        BindingThe codes SHALL be taken from BurgerlijkeStaatCodelijst
                                                                                        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000)

                                                                                        BurgerlijkeStaatCodelijst

                                                                                        TypeCodeableConcept
                                                                                        Is Modifierfalse
                                                                                        Requirements

                                                                                        Most, if not all systems capture it.

                                                                                        Alternate NamesBurgerlijkeStaat
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        336. Patient.multipleBirth[x]
                                                                                        Definition

                                                                                        Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                        ShortWhether patient is part of a multiple birth
                                                                                        Comments

                                                                                        Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                        Control0..0
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        Typeinteger
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Requirements

                                                                                        For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                        • type @ $this
                                                                                        • 338. Patient.multipleBirth[x]:multipleBirthBoolean
                                                                                          Slice NamemultipleBirthBoolean
                                                                                          Definition

                                                                                          An indication stating whether the patient is of a multiple birth.

                                                                                          ShortMultipleBirthIndicator
                                                                                          Comments

                                                                                          Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          Typeboolean
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Requirements

                                                                                          For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                          Alternate NamesMeerlingIndicator
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          340. Patient.photo
                                                                                          Definition

                                                                                          Image of the patient.

                                                                                          ShortImage of the patient
                                                                                          Comments

                                                                                          Guidelines:

                                                                                          • Use id photos, not clinical photos.
                                                                                          • Limit dimensions to thumbnail.
                                                                                          • Keep byte count low to ease resource updates.
                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeAttachment
                                                                                          Is Modifierfalse
                                                                                          Requirements

                                                                                          Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                          Invariantsatt-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()))
                                                                                          342. Patient.contact
                                                                                          Definition

                                                                                          A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                          ShortContact
                                                                                          Comments

                                                                                          Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:

                                                                                          • The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson.
                                                                                          • Information about persons that should be contacted regarding the care for the patient is captured using the Patient.contact resource.

                                                                                          If a person is both a related person and a contact person, then some data duplication is inevitable. The nl-core-ContactPerson can be referenced using the extension in contact:contactPerson.

                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeBackboneElement
                                                                                          Is Modifierfalse
                                                                                          Requirements

                                                                                          Need to track people you can contact about the patient.

                                                                                          Alternate NamesContactpersoon
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                          363. Patient.communication
                                                                                          Definition

                                                                                          A language which may be used to communicate with the patient about his or her health.

                                                                                          ShortLanguageProficiency
                                                                                          Comments

                                                                                          If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeBackboneElement
                                                                                          Is Modifierfalse
                                                                                          Requirements

                                                                                          If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                          Alternate NamesTaalvaardigheid
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          391. Patient.generalPractitioner
                                                                                          Definition

                                                                                          A reference from one resource to another.

                                                                                          ShortA reference from one resource to another
                                                                                          Comments

                                                                                          Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.

                                                                                          In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.

                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeReference(Reference)(Organization, Practitioner, PractitionerRole, nl core HealthProfessional PractitionerRole)
                                                                                          Is Modifierfalse
                                                                                          Alternate NamescareProvider
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                                                                                          393. Patient.managingOrganization
                                                                                          Definition

                                                                                          Organization that is the custodian of the patient record.

                                                                                          ShortOrganization that is the custodian of the patient record
                                                                                          Comments

                                                                                          There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                          Control0..1
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeReference(KT2_Organization)
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          Need to know who recognizes this patient record, manages and updates it.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                                                                                          395. Patient.link
                                                                                          Definition

                                                                                          Link to another patient resource that concerns the same actual patient.

                                                                                          ShortLink to another patient resource that concerns the same actual person
                                                                                          Comments

                                                                                          There is no assumption that linked patient records have mutual links.

                                                                                          Control0..0
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeBackboneElement
                                                                                          Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          There are multiple use cases:

                                                                                          • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                          • Distribution of patient information across multiple servers.
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))