zib-ContactPerson
type: StructureDefinition
node role: treeRoot
id:
  v: zib-ContactPerson
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> RelatedPerson 0..* RelatedPerson This is an abstract profile. Child profiles: NlcoreContactPerson Contact Slices for relationship 0..* CodeableConcept The nature of the relationship Slice: Unordered, Open by value:$this relationship:role 0..* CodeableConcept Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required) relationship:relationship 0..* CodeableConcept Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required) Slices for name 0..* HumanName NameInformation / PayerName Slice: Unordered, Open by value:use name:nameInformation 0..2 ZibNameInformation NameInformation name:nameInformation-GivenName 0..* ZibNameInformationGivenName Name of a human - parts and usage Slices for telecom 0..* ContactPoint ContactInformation Slice: Unordered, Open by profile:$this telecom:telephoneNumbers 0..* ZibContactInformationTelephoneNumbers TelephoneNumbers telecom:emailAddresses 0..* ZibContactInformationEmailAddresses EmailAddresses address 0..* ZibAddressInformation AddressInformation <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactPerson
version:
  v: 0.9.0
name:
  v: ZibContactPerson
title:
  v: zib ContactPerson
status:
  v: draft
date:
  v: 2023-10-17T18:06:34+02:00
publisher:
  v: HL7NL
contact:
  name:
    v: HL7NL
  telecom:
    system:
      v: url
    value:
      v: https://hl7.nl
description:
  v: A contact is a person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives. In addition to identification information such as the name, address and contact information can also be entered. The relationship to the patient and the role this person has can be entered as well.
purpose:
  v: This RelatedPerson resource represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) ContactPerson v3.4 (2020)](https://zibs.nl/wiki/ContactPerson-v3.4(2020EN)).
copyright:
  v: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  uri:
    v: https://zibs.nl/wiki/ContactPerson-v3.4(2020EN)
  name:
    v: zib ContactPerson-v3.4(2020EN)
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  uri:
    v: https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)
  name:
    v: zib ContactInformation-v1.2(2020EN)
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  uri:
    v: https://zibs.nl/wiki/Payer-v3.1.1(2020EN)
  name:
    v: zib Payer-v3.1.1(2020EN)
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
kind:
  v: resource
abstract:
  v: true
type:
  v: RelatedPerson
base definition:
  v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: RelatedPerson
    path:
      v: RelatedPerson
    short:
      v: Contact
    definition:
      v: 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.
    comment:
      v: Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: * The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. * Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable.
    alias:
      v: Contactpersoon
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: RelatedPerson
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act
    mapping:
      identity:
        v: rim
      map:
        v: role
    mapping:
      identity:
        v: zib-contactperson-v3.4-2020EN

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: NL-CM:3.1.1

v: Contact

id:
  v: RelatedPerson.id
path:
  v: RelatedPerson.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedPerson.meta
path:
  v: RelatedPerson.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: RelatedPerson.implicitRules
path:
  v: RelatedPerson.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
is summary:
  v: true

id:
  v: RelatedPerson.language
path:
  v: RelatedPerson.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: 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).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages

id:
  v: RelatedPerson.text
path:
  v: RelatedPerson.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: RelatedPerson.contained
path:
  v: RelatedPerson.contained
short:
  v: Contained, inline Resources
definition:
  v: 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.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.extension
path:
  v: RelatedPerson.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.modifierExtension
path:
  v: RelatedPerson.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.identifier
path:
  v: RelatedPerson.identifier
short:
  v: A human identifier for this person
definition:
  v: Identifier for a person within a particular scope.
requirements:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: NK1-33
mapping:
  identity:
    v: rim
  map:
    v: .id

id:
  v: RelatedPerson.active
path:
  v: RelatedPerson.active
short:
  v: Whether this related person's record is in active use
definition:
  v: Whether this related person record is in active use.
comment:
  v: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
requirements:
  v: Need to be able to mark a related person record as not to be used, such as if it was created in error.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.active
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
meaning when missing:
  v: This resource is generally assumed to be active if no value is provided for the active element
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: rim
  map:
    v: .statusCode

id:
  v: RelatedPerson.patient
path:
  v: RelatedPerson.patient
short:
  v: The patient this person is related to
definition:
  v: The patient this person is related to.
requirements:
  v: We need to know which patient this RelatedPerson is related to.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: RelatedPerson.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id

id:
  v: RelatedPerson.relationship
path:
  v: RelatedPerson.relationship
slicing:
  discriminator:
    type:
      v: value
    path:
      v: $this
  rules:
    v: open
short:
  v: The nature of the relationship
definition:
  v: The nature of the relationship between a patient and the related person.
requirements:
  v: We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: PatientRelationshipType
  strength:
    v: preferred
  description:
    v: The nature of the relationship between a patient and the related person.
  value set:
    v: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    link: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code

id:
  v: RelatedPerson.relationship:role
path:
  v: RelatedPerson.relationship
slice name:
  v: role
short:
  v: Role
definition:
  v: Defines the role of the contact in relation to the patient.
requirements:
  v: We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
alias:
  v: Rol
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.2
  comment:
    v: Role

id:
  v: RelatedPerson.relationship:relationship
path:
  v: RelatedPerson.relationship
slice name:
  v: relationship
short:
  v: Relationship
definition:
  v: Defines the contact’s familial relationship to the patient.
requirements:
  v: We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
alias:
  v: Relatie
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.3
  comment:
    v: Relationship

id:
  v: RelatedPerson.name
path:
  v: RelatedPerson.name
slicing:
  discriminator:
    type:
      v: value
    path:
      v: use
  rules:
    v: open
short:
  v: NameInformation / PayerName
definition:
  v: Full name of the contact.
requirements:
  v: Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
alias:
  v: Naamgegevens
alias:
  v: BetalerNaam
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: NK1-2
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.4
  comment:
    v: NameInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName

id:
  v: RelatedPerson.name:nameInformation
path:
  v: RelatedPerson.name
slice name:
  v: nameInformation
short:
  v: NameInformation
definition:
  v: This slice represents the person's official name information, including given names, last name and possibly the partner's last name.
comment:
  v: This `.name` element represents a Dutch name according to the [zib NameInformation (v1.1, 2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the `.text` element. **Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. **Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_. **Note 3**: The examples illustrate how the zib is mapped to FHIR.
requirements:
  v: Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
alias:
  v: Naamgegevens
min:
  v: 0
max:
  v: 2
base:
  path:
    v: RelatedPerson.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation
    link: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: zib-NameInformation-1
  severity:
    v: error
  human:
    v: If a prefix for a family name is specified, the family name is expected as well
  expression:
    v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
  source:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
constraint:
  key:
    v: zib-NameInformation-2
  severity:
    v: error
  human:
    v: If the prefix for a partner family name is specified, the partner family name is expected as well
  expression:
    v: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
  source:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XPN
mapping:
  identity:
    v: rim
  map:
    v: EN (actually, PN)
mapping:
  identity:
    v: servd
  map:
    v: ProviderName
mapping:
  identity:
    v: zib-nameinformation-v1.1-2020EN
  map:
    v: NL-CM:20.4.1
  comment:
    v: NameInformation

id:
  v: RelatedPerson.name:nameInformation-GivenName
path:
  v: RelatedPerson.name
slice name:
  v: nameInformation-GivenName
short:
  v: Name of a human - parts and usage
definition:
  v: This slice represents the name information normally used to address the person.
comment:
  v: This `.name` element represents the Dutch given name ("roepnaam") according to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)). **Note 1**: This element should only contain a person's _unofficial_ name. The official names are represented in one or more other `.name` elements with `.name.use` = _official_. **Note 2**: The examples illustrate how the zib is mapped to FHIR.
requirements:
  v: Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation.GivenName
    link: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation.GivenName
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XPN
mapping:
  identity:
    v: rim
  map:
    v: EN (actually, PN)
mapping:
  identity:
    v: servd
  map:
    v: ProviderName

id:
  v: RelatedPerson.telecom
path:
  v: RelatedPerson.telecom
slicing:
  discriminator:
    type:
      v: profile
    path:
      v: $this
  rules:
    v: open
short:
  v: ContactInformation
definition:
  v: The contact’s telephone number and/or e-mail address.
comment:
  v: The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
alias:
  v: Contactgegevens
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: NK1-5 / NK1-6 / NK1-40
mapping:
  identity:
    v: rim
  map:
    v: telecom
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.6
  comment:
    v: ContactInformation
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  map:
    v: NL-CM:20.6.1
  comment:
    v: ContactInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.12
  comment:
    v: ContactInformation

id:
  v: RelatedPerson.telecom:telephoneNumbers
path:
  v: RelatedPerson.telecom
slice name:
  v: telephoneNumbers
short:
  v: TelephoneNumbers
definition:
  v: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
comment:
  v: Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
alias:
  v: Telefoonnummers
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelephoneNumbers
    link: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelephoneNumbers
condition:
  v: ele-1
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    link: http://hl7.org/fhir/StructureDefinition/ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  map:
    v: NL-CM:20.6.2
  comment:
    v: TelephoneNumbers

id:
  v: RelatedPerson.telecom:emailAddresses
path:
  v: RelatedPerson.telecom
slice name:
  v: emailAddresses
short:
  v: EmailAddresses
definition:
  v: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
comment:
  v: Implementation of the "EmailAddresses" concept of zib ContactInformation.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
alias:
  v: EmailAdressen
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses
    link: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses
condition:
  v: ele-1
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    link: http://hl7.org/fhir/StructureDefinition/ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  map:
    v: NL-CM:20.6.3
  comment:
    v: EmailAddresses

id:
  v: RelatedPerson.gender
path:
  v: RelatedPerson.gender
short:
  v: male | female | other | unknown
definition:
  v: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
requirements:
  v: Needed for identification of the person, in combination with (at least) name and birth date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: AdministrativeGender
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: required
  description:
    v: The gender of a person used for administrative purposes.
  value set:
    v: http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: NK1-15
mapping:
  identity:
    v: rim
  map:
    v: administrativeGender

id:
  v: RelatedPerson.birthDate
path:
  v: RelatedPerson.birthDate
short:
  v: The date on which the related person was born
definition:
  v: The date on which the related person was born.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.birthDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: player.birthTime

id:
  v: RelatedPerson.address
path:
  v: RelatedPerson.address
short:
  v: AddressInformation
definition:
  v: Contact’s address information.
comment:
  v: This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the [zib AddressInformation v1.1 (2020)](https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. **Separate address parts** The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. **Custom address types** The second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse> and <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType> as well). The code from the zib should also be included using the extension on `Address.extension:addressType`. | zib | .ext:addressType | .use | .type | |-----------------------------------|------------------|------|----------| | Postal Address/Postadres | PST | | postal | | Primary Home/Officieel adres | HP | home | both | | Visit Address/Woon-/verblijfadres | PHYS | home | physical | | Temporary Address/Tijdelijk adres | TMP | temp | | | Work Place/Werkadres | WP | work | | | Vacation Home/Vakantie adres | HV | temp | | If `Address.type` is _both_ then this is to be understood as a dual purpose address (post…
requirements:
  v: Need to keep track where the related person can be contacted per postal mail or visited.
alias:
  v: Adresgegevens
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.address
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Address
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation
    link: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XAD
mapping:
  identity:
    v: rim
  map:
    v: AD
mapping:
  identity:
    v: servd
  map:
    v: Address
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.1
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.5
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.17
  comment:
    v: AddressInformation

id:
  v: RelatedPerson.photo
path:
  v: RelatedPerson.photo
short:
  v: Image of the person
definition:
  v: Image of the person.
requirements:
  v: Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.photo
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Attachment
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 - needs a profile
mapping:
  identity:
    v: rim
  map:
    v: player[classCode='PSN' and determinerCode='INSTANCE']/desc

id:
  v: RelatedPerson.period
path:
  v: RelatedPerson.period
short:
  v: Period of time that this relationship is considered valid
definition:
  v: The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: rim
  map:
    v: .effectiveTime

id:
  v: RelatedPerson.communication
path:
  v: RelatedPerson.communication
short:
  v: A language which may be used to communicate with about the patient's health
definition:
  v: A language which may be used to communicate with about the patient's health.
comment:
  v: If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
requirements:
  v: If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
min:
  v: 0
max:
  v: *
base:
  path:
    v: RelatedPerson.communication
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: LanguageCommunication

id:
  v: RelatedPerson.communication.id
path:
  v: RelatedPerson.communication.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.communication.extension
path:
  v: RelatedPerson.communication.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: RelatedPerson.communication.modifierExtension
path:
  v: RelatedPerson.communication.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: RelatedPerson.communication.language
path:
  v: RelatedPerson.communication.language
short:
  v: The language which can be used to communicate with the patient about his or her health
definition:
  v: The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
comment:
  v: The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
requirements:
  v: Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: RelatedPerson.communication.language
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code

id:
  v: RelatedPerson.communication.preferred
path:
  v: RelatedPerson.communication.preferred
short:
  v: Language preference indicator
definition:
  v: Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
comment:
  v: This language is specifically identified for communicating healthcare information.
requirements:
  v: People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RelatedPerson.communication.preferred
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: preferenceInd

element:
  id:
    v: RelatedPerson
  path:
    v: RelatedPerson
  short:
    v: Contact
  comment:
    v: Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: * The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. * Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable.
  alias:
    v: Contactpersoon
  mapping:
    identity:
      v: zib-contactperson-v3.4-2020EN
    map:
      v: NL-CM:3.1.1
    comment:
      v: Contact
element:
  id:
    v: RelatedPerson.relationship
  path:
    v: RelatedPerson.relationship
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: $this
    rules:
      v: open
element:
  id:
    v: RelatedPerson.relationship:role
  path:
    v: RelatedPerson.relationship
  slice name:
    v: role
  short:
    v: Role
  definition:
    v: Defines the role of the contact in relation to the patient.
  alias:
    v: Rol
  binding:
    strength:
      v: required
    value set:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
      link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
  mapping:
    identity:
      v: zib-contactperson-v3.4-2020EN
    map:
      v: NL-CM:3.1.2
    comment:
      v: Role
element:
  id:
    v: RelatedPerson.relationship:relationship
  path:
    v: RelatedPerson.relationship
  slice name:
    v: relationship
  short:
    v: Relationship
  definition:
    v: Defines the contact’s familial relationship to the patient.
  alias:
    v: Relatie
  binding:
    strength:
      v: required
    value set:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
      link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
  mapping:
    identity:
      v: zib-contactperson-v3.4-2020EN
    map:
      v: NL-CM:3.1.3
    comment:
      v: Relationship
element:
  id:
    v: RelatedPerson.name
  path:
    v: RelatedPerson.name
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: use
    rules:
      v: open
  short:
    v: NameInformation / PayerName
  definition:
    v: Full name of the contact.
  alias:
    v: Naamgegevens
  alias:
    v: BetalerNaam
  mapping:
    identity:
      v: zib-contactperson-v3.4-2020EN
    map:
      v: NL-CM:3.1.4
    comment:
      v: NameInformation
  mapping:
    identity:
      v: zib-payer-v3.1.1-2020EN
    map:
      v: NL-CM:1.1.5
    comment:
      v: PayerName
element:
  id:
    v: RelatedPerson.name:nameInformation
  path:
    v: RelatedPerson.name
  slice name:
    v: nameInformation
  max:
    v: 2
  type:
    code:
      v: HumanName
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation
      link: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation
element:
  id:
    v: RelatedPerson.name:nameInformation-GivenName
  path:
    v: RelatedPerson.name
  slice name:
    v: nameInformation-GivenName
  type:
    code:
      v: HumanName
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation.GivenName
      link: http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation.GivenName
element:
  id:
    v: RelatedPerson.telecom
  path:
    v: RelatedPerson.telecom
  slicing:
    discriminator:
      type:
        v: profile
      path:
        v: $this
    rules:
      v: open
  short:
    v: ContactInformation
  definition:
    v: The contact’s telephone number and/or e-mail address.
  comment:
    v: The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.
  alias:
    v: Contactgegevens
  mapping:
    identity:
      v: zib-contactperson-v3.4-2020EN
    map:
      v: NL-CM:3.1.6
    comment:
      v: ContactInformation
  mapping:
    identity:
      v: zib-contactinformation-v1.2-2020EN
    map:
      v: NL-CM:20.6.1
    comment:
      v: ContactInformation
  mapping:
    identity:
      v: zib-payer-v3.1.1-2020EN
    map:
      v: NL-CM:1.1.12
    comment:
      v: ContactInformation
element:
  id:
    v: RelatedPerson.telecom:telephoneNumbers
  path:
    v: RelatedPerson.telecom
  slice name:
    v: telephoneNumbers
  type:
    code:
      v: ContactPoint
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelephoneNumbers
      link: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelephoneNumbers

id:
  v: RelatedPerson.telecom:emailAddresses
path:
  v: RelatedPerson.telecom
slice name:
  v: emailAddresses
type:
  code:
    v: ContactPoint
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses
    link: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses

id:
  v: RelatedPerson.address
path:
  v: RelatedPerson.address
definition:
  v: Contact’s address information.
type:
  code:
    v: Address
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation
    link: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.5
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.17
  comment:
    v: AddressInformation