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

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

Resource Profile: ACPContactPerson - Detailed Descriptions

Draft as of 2025-10-31

Definitions for the ACP-ContactPerson 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()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. 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.

Control0..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()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. RelatedPerson.patient
Definition

The patient this person is related to.

ShortThe patient this person is related to
Control1..1
TypeReference(Patient, Patient)
Is Modifierfalse
Obligations
    ObligationsActor
    SHALL:populate-if-knownACP Actor Provider
    SHALL:no-errorACP Actor Consulter
    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()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. RelatedPerson.relationship
    Definition

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

    ShortThe nature of the relationship
    Control10..*
    BindingThe codes SHOULD be taken from PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1
    (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1)

    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()))
    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 RelatedPerson.relationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 12. 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
      Control10..*
      BindingThe codes SHALL be taken from The codes SHOULD be taken from RolCodelijst (2020-09-01T00:00:00)http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000|2020-09-01T00:00:00)

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

      TypeCodeableConcept
      Is Modifierfalse
      Obligations
        ObligationsActor
        SHALL:populate-if-knownACP Actor Provider
        SHALL:no-errorACP Actor Consulter
        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()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. RelatedPerson.relationship:relationship
        Slice Namerelationship
        Definition

        When someone is or will be a legal representative, then a relationship code 24 from code system urn:oid:2.16.840.1.113883.2.4.3.11.22.472 is added.


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

        ShortRelationshipThe nature of the relationship
        Control0..*
        BindingThe codes SHALL be taken from The codes SHOULD be taken from RelatieCodelijst (2020-09-01T00:00:00)http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1
        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000|2020-09-01T00:00:00)

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

        TypeCodeableConcept
        Is Modifierfalse
        Obligations
          ObligationsActor
          SHALL:populate-if-knownACP Actor Provider
          SHALL:no-errorACP Actor Consulter
          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()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. RelatedPerson.name
          Definition

          Full name of the contact.


          A name associated with the person.

          ShortNameInformation / PayerNameA name associated with the person
          Control0..*
          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()))
          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 RelatedPerson.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ use
          • 18. 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 accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on .family and on .extension:nameUsage for more information.

            Systems that need to work in a Dutch context SHOULD support the extensions as specified in .given, .family and .extension:nameUsage. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:

            • If parts of the name are specified using one or more of the structured elements, the .text element SHOULD be populated with a rendered version of the full name.
            • If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name.

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

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

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

            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())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. RelatedPerson.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
            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())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            22. RelatedPerson.name:nameInformation.extension:nameUsage.extension
            Definition

            An Extension


            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            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..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())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on RelatedPerson.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 24. RelatedPerson.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
              26. RelatedPerson.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()))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. RelatedPerson.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
              Obligations
                ObligationsActor
                SHALL:populate-if-knownACP Actor Provider
                SHALL:no-errorACP Actor Consulter
                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()))
                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. RelatedPerson.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.

                Control0..*
                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
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownACP Actor Provider
                  SHALL:no-errorACP Actor Consulter
                  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()))
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  32. RelatedPerson.name:nameInformation.given.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.


                  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())
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on RelatedPerson.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 34. RelatedPerson.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
                    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())
                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    36. RelatedPerson.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

                    The zib concept 'titles' is mapped to elements HumanName.prefix and HumanName.suffix. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.

                    Export:

                    Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes.

                    If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.

                    Import:

                    Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.

                    Control0..*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Obligations
                      ObligationsActor
                      SHALL:populate-if-knownACP Actor Provider
                      SHALL:no-errorACP Actor Consulter
                      Summarytrue
                      Alternate NamesTitels
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. 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.

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeHumanName(nl core NameInformation.GivenName)
                      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 Namesnl-core-NameInformation.GivenName
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. RelatedPerson.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()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. RelatedPerson.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()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      44. RelatedPerson.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
                      Obligations
                        ObligationsActor
                        SHALL:populate-if-knownACP Actor Provider
                        SHALL:no-errorACP Actor Consulter
                        Summarytrue
                        Alternate Namesfirst name, middle name, Roepnaam
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        46. RelatedPerson.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
                        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()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        48. RelatedPerson.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
                        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()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        50. 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..*
                        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()))
                        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 RelatedPerson.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • profile @ $this
                        • 52. 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
                          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())
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          54. RelatedPerson.telecom:telephoneNumbers.extension:comment
                          Slice Namecomment
                          Definition

                          Optional Extension Element - found in all resources.

                          ShortOptional Extensions Element
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(ext Comment) (Extension Type: string)
                          Is Modifierfalse
                          Obligations
                            ObligationsActor
                            SHALL:populate-if-knownACP Actor Provider
                            SHALL:no-errorACP Actor Consulter
                            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())
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            56. RelatedPerson.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.
                            Summaryfalse
                            Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-Comment
                            58. RelatedPerson.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.


                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortCommentValue of extension
                            Control0..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 NamesToelichting
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            60. RelatedPerson.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 ContactInformationTelephoneNumbersSystem (4.0.1)http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                            (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem|4.0.1)

                            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
                            Obligations
                              ObligationsActor
                              SHALL:populate-if-knownACP Actor Provider
                              SHALL:no-errorACP Actor Consulter
                              Summarytrue
                              Alternate NamesTelecomType
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              62. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType
                              Slice NametelecomType
                              Definition

                              Optional Extension Element - found in all resources.

                              ShortOptional Extensions Element
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Obligations
                                ObligationsActor
                                SHALL:populate-if-knownACP Actor Provider
                                SHALL:no-errorACP Actor Consulter
                                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())
                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                64. RelatedPerson.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.
                                Summaryfalse
                                Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                66. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.value[x]
                                Definition

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


                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                ShortTelecomTypeValue of extension
                                Control0..1
                                BindingThe codes SHALL be taken from For codes, see TelecomTypeCodelijst (2020-09-01T00:00:00)
                                (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000|2020-09-01T00:00:00)
                                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, 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
                                Summaryfalse
                                Alternate NamesTelecomType
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                68. RelatedPerson.telecom:telephoneNumbers.value
                                Definition

                                The person's telephone number.


                                The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                ShortTelephoneNumberThe actual contact point details
                                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
                                Obligations
                                  ObligationsActor
                                  SHALL:populate-if-knownACP Actor Provider
                                  SHALL:no-errorACP Actor Consulter
                                  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()))
                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  70. RelatedPerson.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 ContactInformationTelephoneNumbersUse (4.0.1)http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                  (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse|4.0.1)

                                  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
                                  Obligations
                                    ObligationsActor
                                    SHALL:populate-if-knownACP Actor Provider
                                    SHALL:no-errorACP Actor Consulter
                                    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()))
                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    72. 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
                                    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())
                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    74. RelatedPerson.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
                                    Obligations
                                      ObligationsActor
                                      SHALL:populate-if-knownACP Actor Provider
                                      SHALL:no-errorACP Actor Consulter
                                      Summarytrue
                                      Pattern Valueemail
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      76. RelatedPerson.telecom:emailAddresses.value
                                      Definition

                                      The person's e-mail address


                                      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                      ShortEmailAddressThe actual contact point details
                                      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
                                      Obligations
                                        ObligationsActor
                                        SHALL:populate-if-knownACP Actor Provider
                                        SHALL:no-errorACP Actor Consulter
                                        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()))
                                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        78. RelatedPerson.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 ContactInformationEmailAddressesUse (4.0.1)http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                        (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse|4.0.1)

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


                                        Address where the related person can be contacted or visited.

                                        ShortAddressInformationAddress where the related person can be contacted or visited
                                        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()))
                                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        82. RelatedPerson.address.extension:addressType
                                        Slice NameaddressType
                                        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 AddressInformation.AddressType) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Standard StatusNormative (from Trial Use)
                                        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())
                                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        84. RelatedPerson.address.use
                                        Definition

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


                                        The purpose of this address.

                                        ShortAddressTypehome | work | temp | old | billing - purpose of this address
                                        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 AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                        (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.


                                        The use of an address.

                                        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
                                        Obligations
                                          ObligationsActor
                                          SHALL:populate-if-knownACP Actor Provider
                                          SHALL:no-errorACP Actor Consulter
                                          Summarytrue
                                          Requirements

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

                                          Alternate NamesAdresSoort
                                          ExampleGeneral: home
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          86. RelatedPerson.address.type
                                          Definition

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


                                          Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                          ShortAddressTypepostal | physical | both
                                          Comments

                                          The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


                                          The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                          Control0..1
                                          BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                                          (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.


                                          The type of an address (physical / postal).

                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Obligations
                                            ObligationsActor
                                            SHALL:populate-if-knownACP Actor Provider
                                            SHALL:no-errorACP Actor Consulter
                                            Summarytrue
                                            Alternate NamesAdresSoort
                                            ExampleGeneral: both
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            88. RelatedPerson.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).


                                            The name of the city, town, suburb, village or other community or delivery center.

                                            ShortPlaceOfResidenceName of city, town etc.
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Obligations
                                              ObligationsActor
                                              SHALL:populate-if-knownACP Actor Provider
                                              SHALL:no-errorACP Actor Consulter
                                              Summarytrue
                                              Alternate NamesMunicpality, Woonplaats
                                              ExampleGeneral: Erewhon
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              90. RelatedPerson.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).


                                              The name of the administrative area (county).

                                              ShortMunicipalityDistrict name (aka county)
                                              Comments

                                              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Obligations
                                                ObligationsActor
                                                SHALL:populate-if-knownACP Actor Provider
                                                SHALL:no-errorACP Actor Consulter
                                                Summarytrue
                                                Alternate NamesCounty, Gemeente
                                                ExampleGeneral: Madison
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                92. RelatedPerson.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).


                                                A postal code designating a region defined by the postal service.

                                                ShortPostcodePostal code for area
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:populate-if-knownACP Actor Provider
                                                  SHALL:no-errorACP Actor Consulter
                                                  Summarytrue
                                                  Alternate NamesZip, Postcode
                                                  ExampleGeneral: 9132
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                                  0. RelatedPerson
                                                  2. RelatedPerson.patient
                                                  TypeReference(Patient)
                                                  Obligations
                                                    ObligationsActor
                                                    SHALL:populate-if-knownACP Actor Provider
                                                    SHALL:no-errorACP Actor Consulter
                                                    4. RelatedPerson.relationship
                                                    Control1..?
                                                    6. RelatedPerson.relationship:role
                                                    Slice Namerole
                                                    Control1..?
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:populate-if-knownACP Actor Provider
                                                      SHALL:no-errorACP Actor Consulter
                                                      8. RelatedPerson.relationship:relationship
                                                      Slice Namerelationship
                                                      Definition

                                                      When someone is or will be a legal representative, then a relationship code 24 from code system urn:oid:2.16.840.1.113883.2.4.3.11.22.472 is added.

                                                      Obligations
                                                        ObligationsActor
                                                        SHALL:populate-if-knownACP Actor Provider
                                                        SHALL:no-errorACP Actor Consulter
                                                        10. RelatedPerson.name
                                                        12. RelatedPerson.name:nameInformation
                                                        Slice NamenameInformation
                                                        14. RelatedPerson.name:nameInformation.use
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:populate-if-knownACP Actor Provider
                                                          SHALL:no-errorACP Actor Consulter
                                                          16. RelatedPerson.name:nameInformation.family
                                                          18. RelatedPerson.name:nameInformation.family.extension:prefix
                                                          Slice Nameprefix
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:populate-if-knownACP Actor Provider
                                                            SHALL:no-errorACP Actor Consulter
                                                            20. RelatedPerson.name:nameInformation.family.extension:prefix.value[x]
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            22. RelatedPerson.name:nameInformation.family.extension:lastName
                                                            Slice NamelastName
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:populate-if-knownACP Actor Provider
                                                              SHALL:no-errorACP Actor Consulter
                                                              24. RelatedPerson.name:nameInformation.family.extension:lastName.value[x]
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              26. RelatedPerson.name:nameInformation.family.extension:partnerPrefix
                                                              Slice NamepartnerPrefix
                                                              Obligations
                                                                ObligationsActor
                                                                SHALL:populate-if-knownACP Actor Provider
                                                                SHALL:no-errorACP Actor Consulter
                                                                28. RelatedPerson.name:nameInformation.family.extension:partnerPrefix.value[x]
                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                30. RelatedPerson.name:nameInformation.family.extension:partnerLastName
                                                                Slice NamepartnerLastName
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                  SHALL:no-errorACP Actor Consulter
                                                                  32. RelatedPerson.name:nameInformation.family.extension:partnerLastName.value[x]
                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                  34. RelatedPerson.name:nameInformation.given
                                                                  Obligations
                                                                    ObligationsActor
                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                    SHALL:no-errorACP Actor Consulter
                                                                    36. RelatedPerson.name:nameInformation.suffix
                                                                    Obligations
                                                                      ObligationsActor
                                                                      SHALL:populate-if-knownACP Actor Provider
                                                                      SHALL:no-errorACP Actor Consulter
                                                                      38. RelatedPerson.name:nameInformation-GivenName
                                                                      Slice NamenameInformation-GivenName
                                                                      40. RelatedPerson.name:nameInformation-GivenName.given
                                                                      Obligations
                                                                        ObligationsActor
                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                        SHALL:no-errorACP Actor Consulter
                                                                        42. RelatedPerson.telecom
                                                                        44. RelatedPerson.telecom:telephoneNumbers
                                                                        Slice NametelephoneNumbers
                                                                        46. RelatedPerson.telecom:telephoneNumbers.extension:comment
                                                                        Slice Namecomment
                                                                        Obligations
                                                                          ObligationsActor
                                                                          SHALL:populate-if-knownACP Actor Provider
                                                                          SHALL:no-errorACP Actor Consulter
                                                                          48. RelatedPerson.telecom:telephoneNumbers.extension:comment.value[x]
                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                          50. RelatedPerson.telecom:telephoneNumbers.system
                                                                          Obligations
                                                                            ObligationsActor
                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                            SHALL:no-errorACP Actor Consulter
                                                                            52. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType
                                                                            Slice NametelecomType
                                                                            Obligations
                                                                              ObligationsActor
                                                                              SHALL:populate-if-knownACP Actor Provider
                                                                              SHALL:no-errorACP Actor Consulter
                                                                              54. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.value[x]
                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                              56. RelatedPerson.telecom:telephoneNumbers.value
                                                                              Obligations
                                                                                ObligationsActor
                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                SHALL:no-errorACP Actor Consulter
                                                                                58. RelatedPerson.telecom:telephoneNumbers.use
                                                                                Obligations
                                                                                  ObligationsActor
                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                  60. RelatedPerson.telecom:emailAddresses
                                                                                  Slice NameemailAddresses
                                                                                  62. RelatedPerson.telecom:emailAddresses.system
                                                                                  Obligations
                                                                                    ObligationsActor
                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                    64. RelatedPerson.telecom:emailAddresses.value
                                                                                    Obligations
                                                                                      ObligationsActor
                                                                                      SHALL:populate-if-knownACP Actor Provider
                                                                                      SHALL:no-errorACP Actor Consulter
                                                                                      66. RelatedPerson.address
                                                                                      68. RelatedPerson.address.use
                                                                                      Obligations
                                                                                        ObligationsActor
                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                        70. RelatedPerson.address.type
                                                                                        Obligations
                                                                                          ObligationsActor
                                                                                          SHALL:populate-if-knownACP Actor Provider
                                                                                          SHALL:no-errorACP Actor Consulter
                                                                                          72. RelatedPerson.address.line
                                                                                          74. RelatedPerson.address.line.extension:streetName
                                                                                          Slice NamestreetName
                                                                                          Obligations
                                                                                            ObligationsActor
                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                            76. RelatedPerson.address.line.extension:streetName.value[x]
                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                            78. RelatedPerson.address.line.extension:houseNumber
                                                                                            Slice NamehouseNumber
                                                                                            Obligations
                                                                                              ObligationsActor
                                                                                              SHALL:populate-if-knownACP Actor Provider
                                                                                              SHALL:no-errorACP Actor Consulter
                                                                                              80. RelatedPerson.address.line.extension:houseNumber.value[x]
                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                              82. RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition
                                                                                              Slice NamehouseNumberLetter-houseNumberAddition
                                                                                              Obligations
                                                                                                ObligationsActor
                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                84. RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.value[x]
                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                86. RelatedPerson.address.line.extension:houseNumberIndication
                                                                                                Slice NamehouseNumberIndication
                                                                                                Obligations
                                                                                                  ObligationsActor
                                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                                  88. RelatedPerson.address.line.extension:houseNumberIndication.value[x]
                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                  90. RelatedPerson.address.line.extension:additionalInformation
                                                                                                  Slice NameadditionalInformation
                                                                                                  Obligations
                                                                                                    ObligationsActor
                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                    92. RelatedPerson.address.line.extension:additionalInformation.value[x]
                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                    94. RelatedPerson.address.city
                                                                                                    Obligations
                                                                                                      ObligationsActor
                                                                                                      SHALL:populate-if-knownACP Actor Provider
                                                                                                      SHALL:no-errorACP Actor Consulter
                                                                                                      96. RelatedPerson.address.district
                                                                                                      Obligations
                                                                                                        ObligationsActor
                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                        98. RelatedPerson.address.postalCode
                                                                                                        Obligations
                                                                                                          ObligationsActor
                                                                                                          SHALL:populate-if-knownACP Actor Provider
                                                                                                          SHALL:no-errorACP Actor Consulter
                                                                                                          100. RelatedPerson.address.country
                                                                                                          102. RelatedPerson.address.country.extension:countryCode
                                                                                                          Slice NamecountryCode
                                                                                                          Obligations
                                                                                                            ObligationsActor
                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                            104. RelatedPerson.address.country.extension:countryCode.value[x]
                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]

                                                                                                            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|4.0.1)

                                                                                                            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

                                                                                                            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())
                                                                                                            16. 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())
                                                                                                            18. 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)
                                                                                                            Control0..*
                                                                                                            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()))
                                                                                                            20. 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.

                                                                                                            Control0..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()))
                                                                                                            22. RelatedPerson.patient
                                                                                                            Definition

                                                                                                            The patient this person is related to.

                                                                                                            ShortThe patient this person is related to
                                                                                                            Control1..1
                                                                                                            TypeReference(Patient)
                                                                                                            Is Modifierfalse
                                                                                                            Obligations
                                                                                                              ObligationsActor
                                                                                                              SHALL:populate-if-knownACP Actor Provider
                                                                                                              SHALL:no-errorACP Actor Consulter
                                                                                                              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()))
                                                                                                              24. RelatedPerson.relationship
                                                                                                              Definition

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

                                                                                                              ShortThe nature of the relationship
                                                                                                              Control1..*
                                                                                                              BindingThe codes SHOULD be taken from PatientRelationshipType
                                                                                                              (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1)

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

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

                                                                                                                ShortRole
                                                                                                                Control1..*
                                                                                                                BindingThe codes SHALL be taken from RolCodelijst (2020-09-01T00:00:00)
                                                                                                                (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000|2020-09-01T00:00:00)

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

                                                                                                                TypeCodeableConcept
                                                                                                                Is Modifierfalse
                                                                                                                Obligations
                                                                                                                  ObligationsActor
                                                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                                                  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()))
                                                                                                                  28. RelatedPerson.relationship:relationship
                                                                                                                  Slice Namerelationship
                                                                                                                  Definition

                                                                                                                  When someone is or will be a legal representative, then a relationship code 24 from code system urn:oid:2.16.840.1.113883.2.4.3.11.22.472 is added.

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

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

                                                                                                                  TypeCodeableConcept
                                                                                                                  Is Modifierfalse
                                                                                                                  Obligations
                                                                                                                    ObligationsActor
                                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                                    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()))
                                                                                                                    30. RelatedPerson.name
                                                                                                                    Definition

                                                                                                                    Full name of the contact.

                                                                                                                    ShortNameInformation / PayerName
                                                                                                                    Control0..*
                                                                                                                    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
                                                                                                                    • 32. 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 accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on .family and on .extension:nameUsage for more information.

                                                                                                                      Systems that need to work in a Dutch context SHOULD support the extensions as specified in .given, .family and .extension:nameUsage. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:

                                                                                                                      • If parts of the name are specified using one or more of the structured elements, the .text element SHOULD be populated with a rendered version of the full name.
                                                                                                                      • If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name.

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

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

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

                                                                                                                      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())
                                                                                                                      34. RelatedPerson.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
                                                                                                                      36. RelatedPerson.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 RelatedPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                      • value @ url
                                                                                                                      • 38. RelatedPerson.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
                                                                                                                        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())
                                                                                                                        40. RelatedPerson.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
                                                                                                                        42. RelatedPerson.name:nameInformation.extension:nameUsage.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 RelatedPerson.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                        • value @ url
                                                                                                                        • 44. RelatedPerson.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
                                                                                                                          46. RelatedPerson.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()))
                                                                                                                          48. RelatedPerson.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
                                                                                                                          Obligations
                                                                                                                            ObligationsActor
                                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                                            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()))
                                                                                                                            50. RelatedPerson.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

                                                                                                                            A representation of the full name, including given names and the family name.

                                                                                                                            When implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.

                                                                                                                            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()))
                                                                                                                            52. RelatedPerson.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.

                                                                                                                            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
                                                                                                                            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())
                                                                                                                            54. RelatedPerson.name:nameInformation.family.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
                                                                                                                            56. RelatedPerson.name:nameInformation.family.extension
                                                                                                                            Definition

                                                                                                                            May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                            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 RelatedPerson.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                            • value @ url
                                                                                                                            • 58. RelatedPerson.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
                                                                                                                              Obligations
                                                                                                                                ObligationsActor
                                                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                                                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())
                                                                                                                                60. RelatedPerson.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
                                                                                                                                62. RelatedPerson.name:nameInformation.family.extension:prefix.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 RelatedPerson.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                • value @ url
                                                                                                                                • 64. RelatedPerson.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
                                                                                                                                  66. RelatedPerson.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()))
                                                                                                                                  68. RelatedPerson.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
                                                                                                                                  Obligations
                                                                                                                                    ObligationsActor
                                                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                                                    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())
                                                                                                                                    70. RelatedPerson.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
                                                                                                                                    72. RelatedPerson.name:nameInformation.family.extension:lastName.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 RelatedPerson.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                    • value @ url
                                                                                                                                    • 74. RelatedPerson.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
                                                                                                                                      76. RelatedPerson.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()))
                                                                                                                                      78. RelatedPerson.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
                                                                                                                                      Obligations
                                                                                                                                        ObligationsActor
                                                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                                                        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())
                                                                                                                                        80. RelatedPerson.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
                                                                                                                                        82. RelatedPerson.name:nameInformation.family.extension:partnerPrefix.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 RelatedPerson.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                        • value @ url
                                                                                                                                        • 84. RelatedPerson.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
                                                                                                                                          86. RelatedPerson.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()))
                                                                                                                                          88. RelatedPerson.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
                                                                                                                                          Obligations
                                                                                                                                            ObligationsActor
                                                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                                                            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())
                                                                                                                                            90. RelatedPerson.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
                                                                                                                                            92. RelatedPerson.name:nameInformation.family.extension:partnerLastName.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 RelatedPerson.name.family.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                            • value @ url
                                                                                                                                            • 94. RelatedPerson.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
                                                                                                                                              96. RelatedPerson.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()))
                                                                                                                                              98. RelatedPerson.name:nameInformation.family.value
                                                                                                                                              Definition

                                                                                                                                              The actual value

                                                                                                                                              ShortPrimitive value for string
                                                                                                                                              Control0..1
                                                                                                                                              Typestring
                                                                                                                                              Is Modifierfalse
                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                              Summaryfalse
                                                                                                                                              Max Length:1048576
                                                                                                                                              100. RelatedPerson.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.

                                                                                                                                              Control0..*
                                                                                                                                              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
                                                                                                                                              Obligations
                                                                                                                                                ObligationsActor
                                                                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                                                                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()))
                                                                                                                                                102. RelatedPerson.name:nameInformation.given.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
                                                                                                                                                104. RelatedPerson.name:nameInformation.given.extension
                                                                                                                                                Definition

                                                                                                                                                May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                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 RelatedPerson.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                • value @ url
                                                                                                                                                • 106. RelatedPerson.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
                                                                                                                                                  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())
                                                                                                                                                  108. RelatedPerson.name:nameInformation.given.value
                                                                                                                                                  Definition

                                                                                                                                                  The actual value

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

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

                                                                                                                                                  ShortTitles
                                                                                                                                                  Comments

                                                                                                                                                  The zib concept 'titles' is mapped to elements HumanName.prefix and HumanName.suffix. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.

                                                                                                                                                  Export:

                                                                                                                                                  Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes.

                                                                                                                                                  If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.

                                                                                                                                                  Import:

                                                                                                                                                  Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.

                                                                                                                                                  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()))
                                                                                                                                                  112. RelatedPerson.name:nameInformation.suffix
                                                                                                                                                  Definition

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

                                                                                                                                                  ShortTitles
                                                                                                                                                  Comments

                                                                                                                                                  The zib concept 'titles' is mapped to elements HumanName.prefix and HumanName.suffix. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.

                                                                                                                                                  Export:

                                                                                                                                                  Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes.

                                                                                                                                                  If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.

                                                                                                                                                  Import:

                                                                                                                                                  Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.

                                                                                                                                                  Control0..*
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Obligations
                                                                                                                                                    ObligationsActor
                                                                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                                                                    Summarytrue
                                                                                                                                                    Alternate NamesTitels
                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    114. RelatedPerson.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
                                                                                                                                                    Control0..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()))
                                                                                                                                                    116. 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
                                                                                                                                                    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()))
                                                                                                                                                    118. RelatedPerson.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
                                                                                                                                                    120. RelatedPerson.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 RelatedPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                    • value @ url
                                                                                                                                                    • 122. RelatedPerson.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()))
                                                                                                                                                      124. RelatedPerson.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

                                                                                                                                                      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()))
                                                                                                                                                      126. RelatedPerson.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()))
                                                                                                                                                      128. RelatedPerson.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
                                                                                                                                                      Obligations
                                                                                                                                                        ObligationsActor
                                                                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                                                                        Summarytrue
                                                                                                                                                        Alternate Namesfirst name, middle name, Roepnaam
                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                        130. RelatedPerson.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
                                                                                                                                                        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()))
                                                                                                                                                        132. RelatedPerson.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
                                                                                                                                                        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()))
                                                                                                                                                        134. RelatedPerson.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
                                                                                                                                                        Control0..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()))
                                                                                                                                                        136. 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
                                                                                                                                                        • 138. 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
                                                                                                                                                          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())
                                                                                                                                                          140. RelatedPerson.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
                                                                                                                                                          142. RelatedPerson.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 RelatedPerson.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                          • value @ url
                                                                                                                                                          • 144. RelatedPerson.telecom:telephoneNumbers.extension:comment
                                                                                                                                                            Slice Namecomment
                                                                                                                                                            Definition

                                                                                                                                                            Optional Extension Element - found in all resources.

                                                                                                                                                            ShortOptional Extensions Element
                                                                                                                                                            Control0..1
                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                            TypeExtension(ext Comment) (Extension Type: string)
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            Obligations
                                                                                                                                                              ObligationsActor
                                                                                                                                                              SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                              SHALL:no-errorACP Actor Consulter
                                                                                                                                                              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())
                                                                                                                                                              146. RelatedPerson.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
                                                                                                                                                              148. RelatedPerson.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 RelatedPerson.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                              • value @ url
                                                                                                                                                              • 150. RelatedPerson.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.
                                                                                                                                                                Summaryfalse
                                                                                                                                                                Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-Comment
                                                                                                                                                                152. RelatedPerson.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
                                                                                                                                                                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 NamesToelichting
                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                154. RelatedPerson.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 ContactInformationTelephoneNumbersSystem (4.0.1)
                                                                                                                                                                (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem|4.0.1)

                                                                                                                                                                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
                                                                                                                                                                Obligations
                                                                                                                                                                  ObligationsActor
                                                                                                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Alternate NamesTelecomType
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  156. RelatedPerson.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
                                                                                                                                                                  158. RelatedPerson.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 RelatedPerson.telecom.system.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                  • value @ url
                                                                                                                                                                  • 160. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType
                                                                                                                                                                    Slice NametelecomType
                                                                                                                                                                    Definition

                                                                                                                                                                    Optional Extension Element - found in all resources.

                                                                                                                                                                    ShortOptional Extensions Element
                                                                                                                                                                    Control0..1
                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                    TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    Obligations
                                                                                                                                                                      ObligationsActor
                                                                                                                                                                      SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                      SHALL:no-errorACP Actor Consulter
                                                                                                                                                                      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())
                                                                                                                                                                      162. RelatedPerson.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
                                                                                                                                                                      164. RelatedPerson.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 RelatedPerson.telecom.system.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                      • value @ url
                                                                                                                                                                      • 166. RelatedPerson.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.
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                                                                                                                                                        168. RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.value[x]
                                                                                                                                                                        Definition

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

                                                                                                                                                                        ShortTelecomType
                                                                                                                                                                        Control0..1
                                                                                                                                                                        BindingThe codes SHALL be taken from TelecomTypeCodelijst (2020-09-01T00:00:00)
                                                                                                                                                                        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000|2020-09-01T00:00:00)
                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        Alternate NamesTelecomType
                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        170. RelatedPerson.telecom:telephoneNumbers.system.value
                                                                                                                                                                        Definition

                                                                                                                                                                        Primitive value for code

                                                                                                                                                                        ShortPrimitive value for code
                                                                                                                                                                        Control0..1
                                                                                                                                                                        Typestring
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        172. RelatedPerson.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
                                                                                                                                                                        Obligations
                                                                                                                                                                          ObligationsActor
                                                                                                                                                                          SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                          SHALL:no-errorACP Actor Consulter
                                                                                                                                                                          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()))
                                                                                                                                                                          174. RelatedPerson.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 ContactInformationTelephoneNumbersUse (4.0.1)
                                                                                                                                                                          (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse|4.0.1)

                                                                                                                                                                          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
                                                                                                                                                                          Obligations
                                                                                                                                                                            ObligationsActor
                                                                                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                                                                                            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()))
                                                                                                                                                                            176. RelatedPerson.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

                                                                                                                                                                            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()))
                                                                                                                                                                            178. RelatedPerson.telecom:telephoneNumbers.period
                                                                                                                                                                            Definition

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

                                                                                                                                                                            ShortTime period when the contact point was/is in use
                                                                                                                                                                            Control0..1
                                                                                                                                                                            TypePeriod
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            180. 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
                                                                                                                                                                            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())
                                                                                                                                                                            182. RelatedPerson.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
                                                                                                                                                                            184. RelatedPerson.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 RelatedPerson.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                            • value @ url
                                                                                                                                                                            • 186. RelatedPerson.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
                                                                                                                                                                              Obligations
                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Pattern Valueemail
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                188. RelatedPerson.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
                                                                                                                                                                                Obligations
                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                  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()))
                                                                                                                                                                                  190. RelatedPerson.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 ContactInformationEmailAddressesUse (4.0.1)
                                                                                                                                                                                  (required to http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse|4.0.1)

                                                                                                                                                                                  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()))
                                                                                                                                                                                  192. RelatedPerson.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

                                                                                                                                                                                  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()))
                                                                                                                                                                                  194. RelatedPerson.telecom:emailAddresses.period
                                                                                                                                                                                  Definition

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

                                                                                                                                                                                  ShortTime period when the contact point was/is in use
                                                                                                                                                                                  Control0..1
                                                                                                                                                                                  TypePeriod
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  196. RelatedPerson.gender
                                                                                                                                                                                  Definition

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

                                                                                                                                                                                  Shortmale | female | other | unknown
                                                                                                                                                                                  Control0..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()))
                                                                                                                                                                                  198. RelatedPerson.birthDate
                                                                                                                                                                                  Definition

                                                                                                                                                                                  The date on which the related person was born.

                                                                                                                                                                                  ShortThe date on which the related person was born
                                                                                                                                                                                  Control0..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()))
                                                                                                                                                                                  200. 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()))
                                                                                                                                                                                  202. RelatedPerson.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
                                                                                                                                                                                  204. RelatedPerson.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 RelatedPerson.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                  • value @ url
                                                                                                                                                                                  • 206. RelatedPerson.address.extension:addressType
                                                                                                                                                                                    Slice NameaddressType
                                                                                                                                                                                    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 AddressInformation.AddressType) (Extension Type: CodeableConcept)
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Standard StatusNormative (from Trial Use)
                                                                                                                                                                                    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())
                                                                                                                                                                                    208. RelatedPerson.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
                                                                                                                                                                                    Obligations
                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                      SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                      SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                      Requirements

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

                                                                                                                                                                                      Alternate NamesAdresSoort
                                                                                                                                                                                      ExampleGeneral: home
                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      210. RelatedPerson.address.type
                                                                                                                                                                                      Definition

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

                                                                                                                                                                                      ShortAddressType
                                                                                                                                                                                      Comments

                                                                                                                                                                                      The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                                                                                                                                      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
                                                                                                                                                                                      Obligations
                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                        Alternate NamesAdresSoort
                                                                                                                                                                                        ExampleGeneral: both
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        212. RelatedPerson.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

                                                                                                                                                                                        Can provide both a text representation and parts. Applications updating an address 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.

                                                                                                                                                                                        ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        214. RelatedPerson.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
                                                                                                                                                                                        ExampleGeneral: 137 Nowhere Street
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        216. RelatedPerson.address.line.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
                                                                                                                                                                                        218. RelatedPerson.address.line.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 RelatedPerson.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                        • value @ url
                                                                                                                                                                                        • 220. RelatedPerson.address.line.extension:streetName
                                                                                                                                                                                          Slice NamestreetName
                                                                                                                                                                                          Definition

                                                                                                                                                                                          streetName.

                                                                                                                                                                                          ShortstreetName
                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                          Obligations
                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                            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())
                                                                                                                                                                                            222. RelatedPerson.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
                                                                                                                                                                                            224. RelatedPerson.address.line.extension:streetName.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 RelatedPerson.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                            • value @ url
                                                                                                                                                                                            • 226. RelatedPerson.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
                                                                                                                                                                                              228. RelatedPerson.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()))
                                                                                                                                                                                              230. RelatedPerson.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
                                                                                                                                                                                              Control0..1
                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                              TypeExtension(ADXP House Number) (Extension Type: string)
                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                              Obligations
                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                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())
                                                                                                                                                                                                232. RelatedPerson.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
                                                                                                                                                                                                234. RelatedPerson.address.line.extension:houseNumber.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 RelatedPerson.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                • value @ url
                                                                                                                                                                                                • 236. RelatedPerson.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
                                                                                                                                                                                                  238. RelatedPerson.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()))
                                                                                                                                                                                                  240. RelatedPerson.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
                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                  TypeExtension(ADXP Building Number Suffix) (Extension Type: string)
                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                    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. RelatedPerson.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
                                                                                                                                                                                                    244. RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.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 RelatedPerson.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                    • 246. RelatedPerson.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
                                                                                                                                                                                                      248. RelatedPerson.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()))
                                                                                                                                                                                                      250. RelatedPerson.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
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                      TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                        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())
                                                                                                                                                                                                        252. RelatedPerson.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
                                                                                                                                                                                                        254. RelatedPerson.address.line.extension:houseNumberIndication.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 RelatedPerson.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                        • value @ url
                                                                                                                                                                                                        • 256. RelatedPerson.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
                                                                                                                                                                                                          258. RelatedPerson.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'))
                                                                                                                                                                                                          260. RelatedPerson.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
                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                                          TypeExtension(ADXP Unit ID) (Extension Type: string)
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                            SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                            SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                            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())
                                                                                                                                                                                                            262. RelatedPerson.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
                                                                                                                                                                                                            264. RelatedPerson.address.line.extension:additionalInformation.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 RelatedPerson.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                            • value @ url
                                                                                                                                                                                                            • 266. RelatedPerson.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
                                                                                                                                                                                                              268. RelatedPerson.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()))
                                                                                                                                                                                                              270. RelatedPerson.address.line.value
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              The actual value

                                                                                                                                                                                                              ShortPrimitive value for string
                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                              Max Length:1048576
                                                                                                                                                                                                              272. RelatedPerson.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
                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                                SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Alternate NamesMunicpality, Woonplaats
                                                                                                                                                                                                                ExampleGeneral: Erewhon
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                274. RelatedPerson.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

                                                                                                                                                                                                                District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                  SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                                  SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                  Alternate NamesCounty, Gemeente
                                                                                                                                                                                                                  ExampleGeneral: Madison
                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                  276. RelatedPerson.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)
                                                                                                                                                                                                                  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()))
                                                                                                                                                                                                                  278. RelatedPerson.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
                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                    SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                                    SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Alternate NamesZip, Postcode
                                                                                                                                                                                                                    ExampleGeneral: 9132
                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    280. RelatedPerson.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()))
                                                                                                                                                                                                                    282. RelatedPerson.address.country.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
                                                                                                                                                                                                                    284. RelatedPerson.address.country.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 RelatedPerson.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                                    • 286. RelatedPerson.address.country.extension:countryCode
                                                                                                                                                                                                                      Slice NamecountryCode
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Optional Extension Element - found in all resources.

                                                                                                                                                                                                                      ShortOptional Extensions Element
                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      TypeExtension(ext CodeSpecification) (Extension Type: CodeableConcept)
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                        SHALL:populate-if-knownACP Actor Provider
                                                                                                                                                                                                                        SHALL:no-errorACP Actor Consulter
                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                        288. RelatedPerson.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
                                                                                                                                                                                                                        290. RelatedPerson.address.country.extension:countryCode.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 RelatedPerson.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                        • value @ url
                                                                                                                                                                                                                        • 292. RelatedPerson.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
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                          Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
                                                                                                                                                                                                                          294. RelatedPerson.address.country.extension:countryCode.value[x]
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Country in which the address is located.

                                                                                                                                                                                                                          ShortCountry
                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                          BindingThe codes SHALL be taken from LandCodelijsten (2020-09-01T00:00:00)
                                                                                                                                                                                                                          (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000|2020-09-01T00:00:00)
                                                                                                                                                                                                                          TypeCodeableConcept
                                                                                                                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                          Alternate NamesLand
                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                          296. RelatedPerson.address.country.value
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          The actual value

                                                                                                                                                                                                                          ShortPrimitive value for string
                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                          Max Length:1048576
                                                                                                                                                                                                                          298. RelatedPerson.address.period
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Time period when address was/is in use.

                                                                                                                                                                                                                          ShortTime period when address was/is in use
                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                          TypePeriod
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                                          Allows addresses to be placed in historical context.

                                                                                                                                                                                                                          ExampleGeneral: { "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()))
                                                                                                                                                                                                                          300. RelatedPerson.photo
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Image of the person.

                                                                                                                                                                                                                          ShortImage of the person
                                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                                          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()))
                                                                                                                                                                                                                          302. 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()))
                                                                                                                                                                                                                          304. 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()))
                                                                                                                                                                                                                          306. 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
                                                                                                                                                                                                                          308. 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())
                                                                                                                                                                                                                          310. 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())
                                                                                                                                                                                                                          312. 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|4.0.1)

                                                                                                                                                                                                                          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()))
                                                                                                                                                                                                                          314. 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()))