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

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

Resource Profile: KT2_RelatedPerson - Detailed Descriptions

Draft as of 2026-01-16

Definitions for the KT2RelatedPerson resource profile.

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

0. RelatedPerson
Definition

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

ShortContactA person that is related to a patient, but who is not a direct target of care
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, and therefore this profile, is used to capture information about any person that is related to the patient.
  • 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.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesContactpersoon, nl-core-ContactPerson
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. RelatedPerson.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. RelatedPerson.extension
Definition

An Extension


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.

ShortExtensionAdditional 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..*
This element is affected by the following invariants: ele-1
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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. RelatedPerson.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
    This element is affected by the following invariants: ele-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())
    8. RelatedPerson.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..*
    This element is affected by the following invariants: ele-1
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. RelatedPerson.identifier
    Definition

    Identifier for a person within a particular scope.

    ShortA human identifier for this person
    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

    People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. RelatedPerson.active
    Definition

    Whether this related person record is in active use.

    ShortWhether this related person's record is in active use
    Comments

    This element is labeled as a modifier because it may be used to mark that the resource was created in error.

    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 related person record as not to be used, such as if 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()))
    14. RelatedPerson.patient
    Definition

    The patient this person is related to.

    ShortThe patient this person is related to
    Comments

    References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeReference(KT2_Patient, Patient)
    Is Modifierfalse
    Summarytrue
    Requirements

    We need to know which patient this RelatedPerson is related to.

    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')))
    16. RelatedPerson.relationship
    Definition

    The nature of the relationship between a patient and the related person.

    ShortThe nature of the relationship
    Comments

    See Koppeltaal Implementation Guide for more information on the ValueSet


    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.

    Control10..*
    This element is affected by the following invariants: ele-1
    BindingThe codes SHOULD be taken from PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)

    The nature of the relationship between a patient and the related person.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

    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 RelatedPerson.relationship. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ $this
    • 18. RelatedPerson.relationship:role
      Slice Namerole
      Definition

      Defines the role of the contact in relation to the patient.


      The nature of the relationship between a patient and the related person.

      ShortRoleThe nature of the relationship
      Comments

      When using the display element for COD472 codes 23 (Contactpersoon) and 24 (Wettelijke vertegenwoordiger), you MUST use the exact content of the display element from the CodeSystem. Otherwise, validation will result in errors. These specific codes require strict display validation due to known inconsistencies between different code systems and ValueSets. Other COD472 codes do not enforce display validation. Note that the display of the code in the ValueSet can be different from the CodeSystem.


      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..*
      This element is affected by the following invariants: ele-1
      BindingThe codes SHALL be taken from The codes SHOULD be taken from RolCodelijsthttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000)

      The nature of the relationship between a patient and the related person.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

      Alternate NamesRol
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      kt2-role-display-validation: Display values for role codes 21 and 24 (COD472) must match the CodeSystem definitions exactly (coding.where(system='urn:oid:2.16.840.1.113883.2.4.3.11.22.472').all( (code='23' and display='Contactpersoon') or (code='24' and display='Wettelijke vertegenwoordiger') or code!='23' and code!='24' ))
      20. RelatedPerson.relationship:relationship
      Slice Namerelationship
      Definition

      Defines the contact’s familial relationship to the patient.


      The nature of the relationship between a patient and the related person.

      ShortRelationshipThe nature of the relationship
      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..*
      This element is affected by the following invariants: ele-1
      BindingThe codes SHALL be taken from The codes SHOULD be taken from RelatieCodelijsthttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000)

      The nature of the relationship between a patient and the related person.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

      Alternate NamesRelatie
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. RelatedPerson.name
      Definition

      Full name of the contact.


      A name associated with the person.

      ShortNameInformation / PayerNameA name associated with the person
      Comments

      Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

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

      Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

      Alternate NamesNaamgegevens, BetalerNaam
      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 RelatedPerson.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ use
      • 24. RelatedPerson.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 person.

        ShortNameInformationA name associated with the person
        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.


        Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

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

        Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

        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())
        26. RelatedPerson.name:nameInformation-GivenName
        Slice NamenameInformation-GivenName
        Definition

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


        A name associated with the person.

        ShortName of a human - parts and usageA name associated with the person
        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.


        Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

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

        Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

        Alternate Namesnl-core-NameInformation.GivenName
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. RelatedPerson.telecom
        Definition

        The contact’s telephone number and/or e-mail address.


        A contact detail for the person, e.g. a telephone number or an email address.

        ShortContactInformationA contact detail for the person
        Comments

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


        Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

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

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

        Alternate NamesContactgegevens
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
        SlicingThis element introduces a set of slices on RelatedPerson.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • profile @ $this
        • 30. RelatedPerson.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 for the person, e.g. a telephone number or an email address.

          ShortTelephoneNumbersA contact detail for the person
          Comments

          Implementation of the "TelephoneNumbers" concept of zib ContactInformation.

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


          Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

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

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

          Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          32. RelatedPerson.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 for the person, e.g. a telephone number or an email address.

          ShortEmailAddressesA contact detail for the person
          Comments

          Implementation of the "EmailAddresses" concept of zib ContactInformation.


          Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

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

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

          Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          34. RelatedPerson.gender
          Definition

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

          Shortmale | female | other | unknown
          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)

          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 person, in combination with (at least) name and birth date.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. RelatedPerson.birthDate
          Definition

          The date on which the related person was born.

          ShortThe date on which the related person was born
          Control10..1
          Typedate
          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()))
          38. RelatedPerson.photo
          Definition

          Image of the person.

          ShortImage of the person
          Comments

          When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

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

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())

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

          0. RelatedPerson
          2. RelatedPerson.extension
          SlicingThis element introduces a set of slices on RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 4. RelatedPerson.extension:resource-origin
            Slice Nameresource-origin
            Control0..1
            TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
            6. RelatedPerson.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..?
            8. RelatedPerson.active
            Control1..?
            10. RelatedPerson.patient
            TypeReference(KT2_Patient)
            12. RelatedPerson.relationship
            Comments

            See Koppeltaal Implementation Guide for more information on the ValueSet

            Control1..?
            SlicingThis element introduces a set of slices on RelatedPerson.relationship. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • value @ $this
            • 14. RelatedPerson.relationship:role
              Slice Namerole
              Comments

              When using the display element for COD472 codes 23 (Contactpersoon) and 24 (Wettelijke vertegenwoordiger), you MUST use the exact content of the display element from the CodeSystem. Otherwise, validation will result in errors. These specific codes require strict display validation due to known inconsistencies between different code systems and ValueSets. Other COD472 codes do not enforce display validation. Note that the display of the code in the ValueSet can be different from the CodeSystem.

              Invariantskt2-role-display-validation: Display values for role codes 21 and 24 (COD472) must match the CodeSystem definitions exactly (coding.where(system='urn:oid:2.16.840.1.113883.2.4.3.11.22.472').all( (code='23' and display='Contactpersoon') or (code='24' and display='Wettelijke vertegenwoordiger') or code!='23' and code!='24' ))
              16. RelatedPerson.name
              Control1..?
              18. RelatedPerson.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.

              20. RelatedPerson.gender
              Control1..?
              22. RelatedPerson.birthDate
              Control1..?
              24. RelatedPerson.photo
              Control0..0

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

              0. RelatedPerson
              Definition

              Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

              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, and therefore this profile, is used to capture information about any person that is related to the patient.
              • 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.

              Control0..*
              Is Modifierfalse
              Summaryfalse
              Alternate NamesContactpersoon, nl-core-ContactPerson
              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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              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 RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. RelatedPerson.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
                This element is affected by the following invariants: ele-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. RelatedPerson.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())
                20. RelatedPerson.identifier
                Definition

                Identifier for a person within a particular scope.

                ShortA human identifier for this person
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control1..*
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Requirements

                People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. RelatedPerson.active
                Definition

                Whether this related person record is in active use.

                ShortWhether this related person's record is in active use
                Comments

                This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                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 related person record as not to be used, such as if 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()))
                24. RelatedPerson.patient
                Definition

                The patient this person is related to.

                ShortThe patient this person is related to
                Control1..1
                TypeReference(KT2_Patient)
                Is Modifierfalse
                Summarytrue
                Requirements

                We need to know which patient this RelatedPerson is related to.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. RelatedPerson.relationship
                Definition

                The nature of the relationship between a patient and the related person.

                ShortThe nature of the relationship
                Comments

                See Koppeltaal Implementation Guide for more information on the ValueSet

                Control1..*
                BindingThe codes SHOULD be taken from PatientRelationshipType
                (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)

                The nature of the relationship between a patient and the related person.

                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Requirements

                We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

                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 RelatedPerson.relationship. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • value @ $this
                • 28. RelatedPerson.relationship:role
                  Slice Namerole
                  Definition

                  Defines the role of the contact in relation to the patient.

                  ShortRole
                  Comments

                  When using the display element for COD472 codes 23 (Contactpersoon) and 24 (Wettelijke vertegenwoordiger), you MUST use the exact content of the display element from the CodeSystem. Otherwise, validation will result in errors. These specific codes require strict display validation due to known inconsistencies between different code systems and ValueSets. Other COD472 codes do not enforce display validation. Note that the display of the code in the ValueSet can be different from the CodeSystem.

                  Control0..*
                  BindingThe codes SHALL be taken from RolCodelijst
                  (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000)

                  The nature of the relationship between a patient and the related person.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

                  Alternate NamesRol
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  kt2-role-display-validation: Display values for role codes 21 and 24 (COD472) must match the CodeSystem definitions exactly (coding.where(system='urn:oid:2.16.840.1.113883.2.4.3.11.22.472').all( (code='23' and display='Contactpersoon') or (code='24' and display='Wettelijke vertegenwoordiger') or code!='23' and code!='24' ))
                  30. RelatedPerson.relationship:relationship
                  Slice Namerelationship
                  Definition

                  Defines the contact’s familial relationship to the patient.

                  ShortRelationship
                  Control0..*
                  BindingThe codes SHALL be taken from RelatieCodelijst
                  (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000)

                  The nature of the relationship between a patient and the related person.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

                  Alternate NamesRelatie
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  32. RelatedPerson.name
                  Definition

                  Full name of the contact.

                  ShortNameInformation / PayerName
                  Control1..*
                  TypeHumanName
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

                  Alternate NamesNaamgegevens, BetalerNaam
                  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 RelatedPerson.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ use
                  • 34. RelatedPerson.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

                    Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

                    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())
                    36. RelatedPerson.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
                    Standard StatusNormative (from Trial Use)
                    Summarytrue
                    Requirements

                    Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

                    Alternate Namesnl-core-NameInformation.GivenName
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. RelatedPerson.telecom
                    Definition

                    The contact’s telephone number and/or e-mail address.

                    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..*
                    TypeContactPoint
                    Is Modifierfalse
                    Summarytrue
                    Requirements

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

                    Alternate NamesContactgegevens
                    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 RelatedPerson.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • profile @ $this
                    • 40. RelatedPerson.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
                      Standard StatusNormative (from Trial Use)
                      Summarytrue
                      Requirements

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

                      Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                      42. RelatedPerson.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
                      Standard StatusNormative (from Trial Use)
                      Summarytrue
                      Requirements

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

                      Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                      44. RelatedPerson.gender
                      Definition

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

                      Shortmale | female | other | unknown
                      Control1..1
                      BindingThe codes SHALL be taken from AdministrativeGender
                      (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                      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 person, in combination with (at least) name and birth date.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      46. RelatedPerson.birthDate
                      Definition

                      The date on which the related person was born.

                      ShortThe date on which the related person was born
                      Control1..1
                      Typedate
                      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()))
                      48. RelatedPerson.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

                      Need to keep track where the related person can be contacted per postal mail or visited.

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

                      Image of the person.

                      ShortImage of the person
                      Control0..0
                      TypeAttachment
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      52. RelatedPerson.period
                      Definition

                      The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

                      ShortPeriod of time that this relationship is considered valid
                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      54. RelatedPerson.communication
                      Definition

                      A language which may be used to communicate with about the patient's health.

                      ShortA language which may be used to communicate with about the patient's 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 RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      56. RelatedPerson.communication.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
                      58. RelatedPerson.communication.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())
                      60. RelatedPerson.communication.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

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

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      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, modifiers
                      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())
                      62. RelatedPerson.communication.language
                      Definition

                      The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                      ShortThe language which can be used to communicate with the patient about his or her health
                      Comments

                      The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

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

                      A human language.

                      Additional BindingsPurpose
                      AllLanguagesMax Binding
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      64. RelatedPerson.communication.preferred
                      Definition

                      Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                      ShortLanguage preference indicator
                      Comments

                      This language is specifically identified for communicating healthcare information.

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

                      People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))