IKNL PZP STU3
1.0.0-alpha1 - consultation International flag

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

Resource Profile: ACPContactPerson - Detailed Descriptions

Draft as of 2025-10-23

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.

ShortAn person that is related to a patient, but who is not a direct target of care
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. RelatedPerson.extension:role
Slice Namerole
Definition

Optional Extension Element - found in all resources.

ShortOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(nl-core-relatedperson-role) (Extension Type: CodeableConcept)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. RelatedPerson.extension:role.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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
8. RelatedPerson.extension:role.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control10..1
TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on RelatedPerson.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
  • 10. RelatedPerson.extension:role.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortRoleValue of extension
    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from For codes, see RolCodelijst (2017-12-31T00:00:00)
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000|2017-12-31T00:00:00)
    TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Alternate NamesRol
    12. 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. Usually modifier elements provide negation or qualification. In order 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.

    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    14. 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 No Modifier Reason provideed in previous versions of FHIR
    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.

    Default Valuetrue
    16. RelatedPerson.patient
    Definition

    The patient this person is related to.

    ShortThe patient this person is related to
    Control1..1
    TypeReference(Patient, Patient)
    Summarytrue
    Requirements

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

    18. RelatedPerson.relationship
    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..1
    BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from RelatieCodelijst (2017-12-31T00:00:00)http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|3.0.2
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000|2017-12-31T00:00:00)
    TypeCodeableConcept
    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
    20. RelatedPerson.name
    Definition

    Full name of the contact.


    A name associated with the person.

    ShortNameInformationA name associated with the person
    Control0..*
    TypeHumanName(nl-core-humanname)
    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
    22. RelatedPerson.name.extension:humannameAssemblyOrder
    Slice NamehumannameAssemblyOrder
    Definition

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

    ShortPreferred display order of name parts
    Control0..1
    TypeExtension(assembly-order) (Extension Type: code)
    Alternate NamesVoorkeursvolgorde van de naamdelen.
    24. RelatedPerson.name.extension:humannameAssemblyOrder.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order
    26. RelatedPerson.name.extension:humannameAssemblyOrder.valueCode:valueCode
    Slice NamevalueCode
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..1
    BindingThe codes SHALL be taken from For codes, see HumanNameAssemblyOrder
    (required to http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2)

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

    Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. RelatedPerson.name.use
    Definition

    Identifies the purpose for this name.

    Shortusual | official | temp | nickname | anonymous | old | maiden
    Comments

    This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|3.0.2
    (required to http://hl7.org/fhir/ValueSet/name-use|3.0.2)

    The use of a human name

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    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.

    30. RelatedPerson.name.given
    Definition

    Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot.


    Given name.

    ShortGivenGiven names (not always 'first'). Includes middle names
    Comments

    Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier BR maps to the HCIM concept FirstNames, IN maps to Initials and CL to GivenName.

    Please see the compatibility note on the containing element as well!


    If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate Namesfirst name, middle name, Voornamen, Initialen, Roepnaam
    32. RelatedPerson.name.given.extension:iso21090EnQualifier
    Slice Nameiso21090EnQualifier
    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.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(EN-qualifier) (Extension Type: code)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    34. RelatedPerson.name.given.extension:iso21090EnQualifier.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
    36. RelatedPerson.name.given.extension:iso21090EnQualifier.valueCode:valueCode
    Slice NamevalueCode
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..1
    BindingThe codes SHALL be taken from For codes, see EntityNamePartQualifier
    (required to http://hl7.org/fhir/ValueSet/name-part-qualifier|3.0.2)

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

    Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. RelatedPerson.telecom
    Definition

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

    ShortA contact detail for the person
    Comments

    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(nl-core-contactpoint)
    Summarytrue
    Requirements

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

    40. RelatedPerson.telecom.extension:TelecomType
    Slice NameTelecomType
    Definition

    Defines a more specific coded value for the concept TelecomType used in HCIM ContactInformation, to be able to use the required HCIM value set.

    ShortProvides the specific HCIM code for TelecomType
    Control0..1
    TypeExtension(HCIM ContactInformation TelecomType) (Extension Type: CodeableConcept)
    Alternate NamesDefinieert een specifieke gecodeerde waarde voor het concept TelecomType gebruikt in de zib Contactgegevens, zodat de in de zib gedefinieerde waardelijst kan worden gebruikt.
    42. RelatedPerson.telecom.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
    44. RelatedPerson.telecom.extension:TelecomType.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control10..1
    TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on RelatedPerson.telecom.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • 46. RelatedPerson.telecom.extension:TelecomType.value[x]:valueCodeableConcept
      Slice NamevalueCodeableConcept
      Definition

      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

      ShortValue of extension
      Control10..1
      BindingThe codes SHALL be taken from For codes, see TelecomTypeCodelijst (2017-12-31T00: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--20171231000000|2017-12-31T00:00:00)

      TelecomTypeCodelijst

      TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      48. RelatedPerson.telecom.system
      Definition

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

      ShortTelecomType / EmailAddressTypephone | 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|3.0.2
      (required to http://hl7.org/fhir/ValueSet/contact-point-system|3.0.2)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate NamesTelecomType / EmailSoort
      50. RelatedPerson.telecom.value
      Definition

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

      ShortTelephoneNumber / EmailAddressThe 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Alternate NamesTelefoonnummer / E-mailadres
      ExampleExample TelephoneNumber international: +31611234567
      Example EmailAddress: giesput@myweb.nl
      52. RelatedPerson.telecom.use
      Definition

      Purpose of this contact point


      Identifies the purpose for the contact point.

      ShortTelecomType / NumberType / EmailAddressTypehome | work | temp | old | mobile - purpose of this contact point
      Comments

      This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. 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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|3.0.2
      (required to http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2)
      Typecode
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      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 NamesTelecomType / NummerSoort / EmailSoort
      54. RelatedPerson.address
      Definition

      Address where the related person can be contacted or visited.

      ShortAddressInformationAddress where the related person can be contacted or visited
      Control0..*
      TypeAddress(nl-core-address)
      Summarytrue
      Requirements

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

      Alternate NamesAdresgegevens

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

      0. RelatedPerson
      2. RelatedPerson.extension:role
      Slice Namerole
      4. RelatedPerson.patient
      TypeReference(Patient)
      6. RelatedPerson.relationship
      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.

      8. RelatedPerson.name
      10. RelatedPerson.name.use
      12. RelatedPerson.name.family
      14. RelatedPerson.name.family.extension:humannameOwnPrefix
      Slice NamehumannameOwnPrefix
      16. RelatedPerson.name.family.extension:humannameOwnName
      Slice NamehumannameOwnName
      18. RelatedPerson.name.family.extension:humannamePartnerPrefix
      Slice NamehumannamePartnerPrefix
      20. RelatedPerson.name.family.extension:humannamePartnerName
      Slice NamehumannamePartnerName
      22. RelatedPerson.name.given
      24. RelatedPerson.telecom
      26. RelatedPerson.telecom.extension:TelecomType
      Slice NameTelecomType
      28. RelatedPerson.telecom.system
      30. RelatedPerson.telecom.value
      32. RelatedPerson.telecom.use
      34. RelatedPerson.address

      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.

      ShortAn person that is related to a patient, but who is not a direct target of care
      Control0..*
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
      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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      4. RelatedPerson.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Summarytrue
      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.

      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.

      This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

      Control0..1
      Typeuri
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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
      BindingUnless not suitable, these codes SHALL be taken from Common Languages
      (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

      A human language.

      Additional BindingsPurpose
      All LanguagesMax Binding
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. RelatedPerson.text
      Definition

      A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

      Control0..1
      This element is affected by the following invariants: dom-1
      TypeNarrative
      Alternate Namesnarrative, html, xhtml, display
      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.

      Control0..*
      TypeResource
      Alternate Namesinline resources, anonymous resources, contained resources
      14. RelatedPerson.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      SlicingThis element introduces a set of slices on RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. RelatedPerson.extension:role
        Slice Namerole
        Definition

        Optional Extension Element - found in all resources.

        ShortOptional Extensions Element
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(nl-core-relatedperson-role) (Extension Type: CodeableConcept)
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. RelatedPerson.extension:role.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        20. RelatedPerson.extension:role.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. In order 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.

        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
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on RelatedPerson.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. RelatedPerson.extension:role.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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed Valuehttp://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
          24. RelatedPerson.extension:role.value[x]
          Definition

          Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

          ShortValue of extension
          Control1..1
          TypeCodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          SlicingThis element introduces a set of slices on RelatedPerson.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 26. RelatedPerson.extension:role.value[x]:valueCodeableConcept
            Slice NamevalueCodeableConcept
            Definition

            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

            ShortRole
            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from RolCodelijst (2017-12-31T00:00:00)
            (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000|2017-12-31T00:00:00)
            TypeCodeableConcept
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Alternate NamesRol
            28. 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. Usually modifier elements provide negation or qualification. In order 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.

            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 No Modifier Reason provideed in previous versions of FHIR
            Alternate Namesextensions, user content
            30. 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
            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.

            32. 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 No Modifier Reason provideed in previous versions of FHIR
            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.

            Default Valuetrue
            34. RelatedPerson.patient
            Definition

            The patient this person is related to.

            ShortThe patient this person is related to
            Control1..1
            TypeReference(Patient)
            Summarytrue
            Requirements

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

            36. RelatedPerson.relationship
            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..1
            BindingUnless not suitable, these codes SHALL be taken from RelatieCodelijst (2017-12-31T00:00:00)
            (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000|2017-12-31T00:00:00)
            TypeCodeableConcept
            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
            38. RelatedPerson.name
            Definition

            Full name of the contact.

            ShortNameInformation
            Control0..*
            TypeHumanName(nl-core-humanname)
            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
            40. RelatedPerson.name.id
            Definition

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            42. RelatedPerson.name.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            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
            • 44. RelatedPerson.name.extension:humannameAssemblyOrder
              Slice NamehumannameAssemblyOrder
              Definition

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

              ShortPreferred display order of name parts
              Control0..1
              TypeExtension(assembly-order) (Extension Type: code)
              Alternate NamesVoorkeursvolgorde van de naamdelen.
              46. RelatedPerson.name.extension:humannameAssemblyOrder.id
              Definition

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

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              48. RelatedPerson.name.extension:humannameAssemblyOrder.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. In order 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.

              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
              Alternate Namesextensions, user content
              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
              • 50. RelatedPerson.name.extension:humannameAssemblyOrder.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
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order
                52. RelatedPerson.name.extension:humannameAssemblyOrder.valueCode:valueCode
                Slice NamevalueCode
                Definition

                Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                ShortValue of extension
                Control0..1
                BindingThe codes SHALL be taken from HumanNameAssemblyOrder
                (required to http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2)

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

                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                54. RelatedPerson.name.use
                Definition

                Identifies the purpose for this name.

                Shortusual | official | temp | nickname | anonymous | old | maiden
                Comments

                This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

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

                The use of a human name

                Typecode
                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                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.

                56. RelatedPerson.name.text
                Definition

                A full text representation of the name.

                ShortText representation of the full name
                Comments

                Can provide both a text representation and structured parts.

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

                A renderable, unencoded form.

                58. RelatedPerson.name.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.

                ShortSurname
                Comments

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

                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Alternate Namessurname, Achternaam
                60. RelatedPerson.name.family.id
                Definition

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

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                62. RelatedPerson.name.family.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                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
                • 64. RelatedPerson.name.family.extension:humannameOwnPrefix
                  Slice NamehumannameOwnPrefix
                  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)
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  66. RelatedPerson.name.family.extension:humannameOwnPrefix.id
                  Definition

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

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  68. RelatedPerson.name.family.extension:humannameOwnPrefix.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                  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
                  Alternate Namesextensions, user content
                  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
                  • 70. RelatedPerson.name.family.extension:humannameOwnPrefix.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
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix
                    72. RelatedPerson.name.family.extension:humannameOwnPrefix.valueString:valueString
                    Slice NamevalueString
                    Definition

                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                    ShortValue of extension
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    74. RelatedPerson.name.family.extension:humannameOwnName
                    Slice NamehumannameOwnName
                    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)
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    76. RelatedPerson.name.family.extension:humannameOwnName.id
                    Definition

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

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    78. RelatedPerson.name.family.extension:humannameOwnName.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                    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
                    Alternate Namesextensions, user content
                    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
                    • 80. RelatedPerson.name.family.extension:humannameOwnName.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
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-name
                      82. RelatedPerson.name.family.extension:humannameOwnName.valueString:valueString
                      Slice NamevalueString
                      Definition

                      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                      ShortValue of extension
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      84. RelatedPerson.name.family.extension:humannamePartnerPrefix
                      Slice NamehumannamePartnerPrefix
                      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)
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      86. RelatedPerson.name.family.extension:humannamePartnerPrefix.id
                      Definition

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

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      88. RelatedPerson.name.family.extension:humannamePartnerPrefix.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                      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
                      Alternate Namesextensions, user content
                      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
                      • 90. RelatedPerson.name.family.extension:humannamePartnerPrefix.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
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
                        92. RelatedPerson.name.family.extension:humannamePartnerPrefix.valueString:valueString
                        Slice NamevalueString
                        Definition

                        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                        ShortValue of extension
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        94. RelatedPerson.name.family.extension:humannamePartnerName
                        Slice NamehumannamePartnerName
                        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)
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        96. RelatedPerson.name.family.extension:humannamePartnerName.id
                        Definition

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

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        98. RelatedPerson.name.family.extension:humannamePartnerName.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                        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
                        Alternate Namesextensions, user content
                        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
                        • 100. RelatedPerson.name.family.extension:humannamePartnerName.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
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-name
                          102. RelatedPerson.name.family.extension:humannamePartnerName.valueString:valueString
                          Slice NamevalueString
                          Definition

                          Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                          ShortValue of extension
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          104. RelatedPerson.name.family.value
                          Definition

                          The actual value

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

                          Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot.

                          ShortGiven
                          Comments

                          Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier BR maps to the HCIM concept FirstNames, IN maps to Initials and CL to GivenName.

                          Please see the compatibility note on the containing element as well!

                          Control0..*
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate Namesfirst name, middle name, Voornamen, Initialen, Roepnaam
                          108. RelatedPerson.name.given.id
                          Definition

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

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          110. RelatedPerson.name.given.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          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
                          • 112. RelatedPerson.name.given.extension:iso21090EnQualifier
                            Slice Nameiso21090EnQualifier
                            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.

                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(EN-qualifier) (Extension Type: code)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            114. RelatedPerson.name.given.extension:iso21090EnQualifier.id
                            Definition

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

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            116. RelatedPerson.name.given.extension:iso21090EnQualifier.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                            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
                            Alternate Namesextensions, user content
                            SlicingThis element introduces a set of slices on RelatedPerson.name.given.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 118. RelatedPerson.name.given.extension:iso21090EnQualifier.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
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
                              120. RelatedPerson.name.given.extension:iso21090EnQualifier.valueCode:valueCode
                              Slice NamevalueCode
                              Definition

                              Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                              ShortValue of extension
                              Control0..1
                              BindingThe codes SHALL be taken from EntityNamePartQualifier
                              (required to http://hl7.org/fhir/ValueSet/name-part-qualifier|3.0.2)

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

                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              122. RelatedPerson.name.given.value
                              Definition

                              The actual value

                              ShortPrimitive value for string
                              Control0..1
                              Typestring
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Max Length:1048576
                              124. RelatedPerson.name.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..*
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              126. RelatedPerson.name.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..*
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              128. RelatedPerson.name.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
                              Summarytrue
                              Requirements

                              Allows names to be placed in historical context.

                              130. RelatedPerson.telecom
                              Definition

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

                              ShortA contact detail for the person
                              Comments

                              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(nl-core-contactpoint)
                              Summarytrue
                              Requirements

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

                              132. RelatedPerson.telecom.id
                              Definition

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

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              134. RelatedPerson.telecom.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              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
                              • 136. RelatedPerson.telecom.extension:TelecomType
                                Slice NameTelecomType
                                Definition

                                Defines a more specific coded value for the concept TelecomType used in HCIM ContactInformation, to be able to use the required HCIM value set.

                                ShortProvides the specific HCIM code for TelecomType
                                Control0..1
                                TypeExtension(HCIM ContactInformation TelecomType) (Extension Type: CodeableConcept)
                                Alternate NamesDefinieert een specifieke gecodeerde waarde voor het concept TelecomType gebruikt in de zib Contactgegevens, zodat de in de zib gedefinieerde waardelijst kan worden gebruikt.
                                138. RelatedPerson.telecom.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.

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                140. RelatedPerson.telecom.extension:TelecomType.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                                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
                                Alternate Namesextensions, user content
                                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
                                • 142. RelatedPerson.telecom.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
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
                                  144. RelatedPerson.telecom.extension:TelecomType.value[x]
                                  Definition

                                  Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                  ShortValue of extension
                                  Control1..1
                                  TypeCodeableConcept
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  SlicingThis element introduces a set of slices on RelatedPerson.telecom.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                  • type @ $this
                                  • 146. RelatedPerson.telecom.extension:TelecomType.value[x]:valueCodeableConcept
                                    Slice NamevalueCodeableConcept
                                    Definition

                                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                                    ShortValue of extension
                                    Control1..1
                                    BindingThe codes SHALL be taken from TelecomTypeCodelijst (2017-12-31T00: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--20171231000000|2017-12-31T00:00:00)

                                    TelecomTypeCodelijst

                                    TypeCodeableConcept
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    148. RelatedPerson.telecom.system
                                    Definition

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

                                    ShortTelecomType / EmailAddressType
                                    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|3.0.2)
                                    Typecode
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate NamesTelecomType / EmailSoort
                                    150. RelatedPerson.telecom.value
                                    Definition

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

                                    ShortTelephoneNumber / EmailAddress
                                    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
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

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

                                    Alternate NamesTelefoonnummer / E-mailadres
                                    ExampleExample TelephoneNumber international: +31611234567
                                    Example EmailAddress: giesput@myweb.nl
                                    152. RelatedPerson.telecom.use
                                    Definition

                                    Purpose of this contact point

                                    ShortTelecomType / NumberType / EmailAddressType
                                    Comments

                                    This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                    Control0..1
                                    BindingThe codes SHALL be taken from ContactPointUse
                                    (required to http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2)
                                    Typecode
                                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                    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 NamesTelecomType / NummerSoort / EmailSoort
                                    154. RelatedPerson.telecom.rank
                                    Definition

                                    Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher 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
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    156. RelatedPerson.telecom.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
                                    Summarytrue
                                    158. 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|3.0.2)

                                    The gender of a person used for administrative purposes.

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

                                    160. RelatedPerson.birthDate
                                    Definition

                                    The date on which the related person was born.

                                    ShortThe date on which the related person was born
                                    Control0..1
                                    Typedate
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    162. RelatedPerson.address
                                    Definition

                                    Address where the related person can be contacted or visited.

                                    ShortAddressInformation
                                    Control0..*
                                    TypeAddress(nl-core-address)
                                    Summarytrue
                                    Requirements

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

                                    Alternate NamesAdresgegevens
                                    164. RelatedPerson.photo
                                    Definition

                                    Image of the person.

                                    ShortImage of the person
                                    Control0..*
                                    TypeAttachment
                                    Requirements

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

                                    166. RelatedPerson.period
                                    Definition

                                    The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

                                    ShortPeriod of time that this relationship is considered valid
                                    Control0..1
                                    TypePeriod