ACP-Patient
type: StructureDefinition
node role: treeRoot
id:
  v: ACP-Patient
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ACP-Patient Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Patient 0..* nl-core-patient(2.2.5) Patient #xD; Slices for extension Content/Rules for all slices #xD; extension:legallyCapableMedicalTreatmentDecisions <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/STU3/conformance-rules.html#constraints" title="This element has or is affected by constraints ( ACP-Patient-1 )">C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions #xD; Slices for extension Content/Rules for all slices #xD; extension:legallyCapable 0..1 Extension Extension #xD; extension:legallyCapableComment 0..1 Extension Extension #xD; identifier 0..* Identifier PatientIdentificationNumber #xD; name 0..* nl-core-humanname(2.0.10) NameInformation #xD; use 0..1 code usual | official | temp | nickname | anonymous | old | maiden #xD; family #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:humannameOwnPrefix 0..1 own-prefix Voorvoegsel derived from person's own surname #xD; extension:humannameOwnName 0..1 own-name Portion derived from person's own surname #xD; extension:humannamePartnerPrefix 0..1 partner-prefix Voorvoegsel derived from person's partner's surname #xD; extension:humannamePartnerName 0..1 partner-name Portion derived from person's partner's surname #xD; given 0..* string Given #xD; telecom 0..* nl-core-contactpoint(2.0.8) ContactInformation #xD; gender 0..1 code Gender #xD; birthDate 0..1 date Patients date of birth. The date of birth is mandatory for a patient. An incomplet…
url:
  v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient
  l: ACP-Patient
version:
  v: 1.0.0-rc1
name:
  v: ACPPatient
title:
  v: Patient
status:
  v: draft
experimental:
  v: false
date:
  v: 2026-01-16T10:18:14+00:00
publisher:
  v: IKNL
contact:
  telecom:
    system:
      v: url
    value:
      v: https://www.iknl.nl
description:
  v: A person who receives medical, psychological, paramedical, or nursing care. Based on nl-core-Patient and HCIM Patient.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
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: 3.0.2
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  uri:
    v: https://decor.nictiz.nl/exist/apps/api/dataset/2.16.840.1.113883.2.4.3.11.60.117.1.1/2020-07-29T10%3A37%3A48/$view
    l: https://decor.nictiz.nl/exist/apps/api/dataset/2.16.840.1.113883.2.4.3.11.60.117.1.1/2020-07-29T10%3A37%3A48/$view
  name:
    v: ACP zib2017 dataset
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/Patient-v3.1(2017EN)
    l: Patient-v3.1(2017EN)
  name:
    v: HCIM Patient-v3.1(2017EN)
mapping:
  identity:
    v: hcim-maritalstatus-v3.0-2017EN
  uri:
    v: https://zibs.nl/wiki/MaritalStatus-v3.0(2017EN)
    l: MaritalStatus-v3.0(2017EN)
  name:
    v: HCIM MaritalStatus-v3.0(2017EN)
mapping:
  identity:
    v: hcim-contactperson-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/ContactPerson-v3.1(2017EN)
    l: ContactPerson-v3.1(2017EN)
  name:
    v: HCIM ContactPerson-v3.1(2017EN)
mapping:
  identity:
    v: hcim-healthcareprovider-v3.1.1-2017EN
  uri:
    v: https://zibs.nl/wiki/HealthcareProvider-v3.1.1(2017EN)
    l: HealthcareProvider-v3.1.1(2017EN)
  name:
    v: HCIM HealthcareProvider-v3.1.1(2017EN)
mapping:
  identity:
    v: hcim-healthprofessional-v3.2-2017EN
  uri:
    v: https://zibs.nl/wiki/HealthProfessional-v3.2(2017EN)
    l: HealthProfessional-v3.2(2017EN)
  name:
    v: HCIM HealthProfessional-v3.2(2017EN)
mapping:
  identity:
    v: hcim-nationality-v3.0-2017EN
  uri:
    v: https://zibs.nl/wiki/Nationality-v3.0(2017EN)
    l: Nationality-v3.0(2017EN)
  name:
    v: HCIM Nationality-v3.0(2017EN)
mapping:
  identity:
    v: hcim-payer-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/Payer-v3.1(2017EN)
    l: Payer-v3.1(2017EN)
  name:
    v: HCIM Payer-v3.1(2017EN)
mapping:
  identity:
    v: hcim-contactinformation-v1.0-2017EN
  uri:
    v: https://zibs.nl/wiki/ContactInformation-v1.0(2017EN)
    l: ContactInformation-v1.0(2017EN)
  name:
    v: HCIM ContactInformation-v1.0(2017EN)
  comment:
    v: ContactInformation has become an independent information model as of release 2017 of the HCIMs.
mapping:
  identity:
    v: hcim-languageproficiency-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/LanguageProficiency-v3.1(2017EN)
    l: LanguageProficiency-v3.1(2017EN)
  name:
    v: HCIM LanguageProficiency-v3.1(2017EN)
mapping:
  identity:
    v: hcim-freedomrestrictingmeasures-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/FreedomRestrictingMeasures-v3.1(2017EN)
    l: FreedomRestrictingMeasures-v3.1(2017EN)
  name:
    v: HCIM FreedomRestrictingMeasures-v3.1(2017EN)
  comment:
    v: Concerns only LegalStatus concept. This will become an independent information model as of release 2018 of the HCIMs.
mapping:
  identity:
    v: hcim-basicelements-v1.0-2017EN
  uri:
    v: https://zibs.nl/wiki/BasicElements-v1.0(2017EN)
    l: BasicElements-v1.0(2017EN)
  name:
    v: HCIM BasicElements-v1.0(2017EN)
mapping:
  identity:
    v: hcim-familysituation-v3.0-2017EN
  uri:
    v: https://zibs.nl/wiki/FamilySituation-v3.0(2017EN)
    l: FamilySituation-v3.0(2017EN)
  name:
    v: HCIM FamilySituation-v3.0(2017EN)
mapping:
  identity:
    v: hcim-lifestance-v3.1-2017EN
  uri:
    v: https://zibs.nl/wiki/LifeStance-v3.1(2017EN)
    l: LifeStance-v3.1(2017EN)
  name:
    v: HCIM LifeStance-v3.1(2017EN)
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  uri:
    v: https://zibs.nl/wiki/Patient-v3.0(2016EN)
    l: Patient-v3.0(2016EN)
  name:
    v: HCIM Patient-v3.0(2016EN)
mapping:
  identity:
    v: hcim-maritalstatus-v3.0-2016EN
  uri:
    v: https://zibs.nl/wiki/MaritalStatus-v3.0(2016EN)
    l: MaritalStatus-v3.0(2016EN)
  name:
    v: HCIM MaritalStatus-v3.0(2016EN)
mapping:
  identity:
    v: hcim-contactperson-v3.0-2016EN
  uri:
    v: https://zibs.nl/wiki/ContactPerson-v3.0(2016EN)
    l: ContactPerson-v3.0(2016EN)
  name:
    v: HCIM ContactPerson-v3.0(2016EN)
mapping:
  identity:
    v: hcim-healthcareprovider-v3.0-2016EN
  uri:
    v: https://zibs.nl/wiki/HealthcareProvider-v3.0(2016EN)
    l: HealthcareProvider-v3.0(2016EN)
  name:
    v: HCIM HealthcareProvider-v3.0(2016EN)
mapping:
  identity:
    v: hcim-healthprofessional-v3.0-2016EN
  uri:
    v: https://zibs.nl/wiki/HealthProfessional-v3.0(2016EN)
    l: HealthProfessional-v3.0(2016EN)
  name:
    v: HCIM HealthProfessional-v3.0(2016EN)

identity:
  v: hcim-nationality-v3.0-2016EN
uri:
  v: https://zibs.nl/wiki/Nationality-v3.0(2016EN)
  l: Nationality-v3.0(2016EN)
name:
  v: HCIM Nationality-v3.0(2016EN)

identity:
  v: hcim-payer-v3.0-2016EN
uri:
  v: https://zibs.nl/wiki/Payer-v3.0(2016EN)
  l: Payer-v3.0(2016EN)
name:
  v: HCIM Payer-v3.0(2016EN)

identity:
  v: hcim-familysituation-v3.0-2016EN
uri:
  v: https://zibs.nl/wiki/FamilySituation-v3.0(2016EN)
  l: FamilySituation-v3.0(2016EN)
name:
  v: HCIM FamilySituation-v3.0(2016EN)

identity:
  v: hcim-patient-v2.0.1-2015EN
uri:
  v: https://zibs.nl/wiki/Patient-v2.0.1(2015EN)
  l: Patient-v2.0.1(2015EN)
name:
  v: HCIM Patient-v2.0.1(2015EN)

identity:
  v: hcim-maritalstatus-v1.2.1-2015EN
uri:
  v: https://zibs.nl/wiki/MaritalStatus-v1.2.1(2015EN)
  l: MaritalStatus-v1.2.1(2015EN)
name:
  v: HCIM MaritalStatus-v1.2.1(2015EN)

identity:
  v: hcim-contactperson-v1.2-2015EN
uri:
  v: https://zibs.nl/wiki/ContactPerson-v1.2(2015EN)
  l: ContactPerson-v1.2(2015EN)
name:
  v: HCIM ContactPerson-v1.2(2015EN)

identity:
  v: hcim-healthcareprovider-v1.2-2015EN
uri:
  v: https://zibs.nl/wiki/HealthcareProvider-v1.2(2015EN)
  l: HealthcareProvider-v1.2(2015EN)
name:
  v: HCIM HealthcareProvider-v1.2(2015EN)

identity:
  v: hcim-healthprofessional-v1.2.1-2015EN
uri:
  v: https://zibs.nl/wiki/HealthProfessional-v1.2.1(2015EN)
  l: HealthProfessional-v1.2.1(2015EN)
name:
  v: HCIM HealthProfessional-v1.2.1(2015EN)

identity:
  v: hcim-nationality-v2.0-2015EN
uri:
  v: https://zibs.nl/wiki/Nationality-v2.0(2015EN)
  l: Nationality-v2.0(2015EN)
name:
  v: HCIM Nationality-v2.0(2015EN)

identity:
  v: hcim-payer-v1.2-2015EN
uri:
  v: https://zibs.nl/wiki/Payer-v1.2(2015EN)
  l: Payer-v1.2(2015EN)
name:
  v: HCIM Payer-v1.2(2015EN)

identity:
  v: hcim-familysituation-v1.0-2015EN
uri:
  v: https://zibs.nl/wiki/FamilySituation-v1.0(2015EN)
  l: FamilySituation-v1.0(2015EN)
name:
  v: HCIM FamilySituation-v1.0(2015EN)

v: resource

v: false

v: Patient

v: constraint

extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    l: snapshot-base-version
  value: String
    v: 2.2.5
element:
  id:
    v: Patient
  path:
    v: Patient
  short:
    v: Patient
  definition:
    v: Demographics and other administrative information about an individual or animal receiving care or other health-related services.
  alias:
    v: SubjectOfCare Client Resident
  alias:
    v: Patiënt
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: Resource
    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
      l: DomainResource
  constraint:
    key:
      v: dom-1
    severity:
      v: error
    human:
      v: If the resource is contained in another resource, it SHALL NOT contain any narrative
    expression:
      v: contained.text.empty()
    xpath:
      v: not(parent::f:contained and f:text)
    source:
      v: http://hl7.org/fhir/StructureDefinition/DomainResource
      l: 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
      l: 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
    expression:
      v: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
    xpath:
      v: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
    source:
      v: http://hl7.org/fhir/StructureDefinition/DomainResource
      l: DomainResource
  mapping:
    identity:
      v: pall-izppz-zib2017v2025-03-11
    map:
      v: 11
    comment:
      v: Patient
  mapping:
    identity:
      v: pall-izppz-zib2017v2025-03-11
    map:
      v: 305
    comment:
      v: Gesprek gevoerd in bijzijn van (Patient)
  mapping:
    identity:
      v: rim
    map:
      v: Entity. Role, or Act
  mapping:
    identity:
      v: rim
    map:
      v: Patient[classCode=PAT]
  mapping:
    identity:
      v: cda
    map:
      v: ClinicalDocument.recordTarget.patientRole
  mapping:
    identity:
      v: w5
    map:
      v: administrative.individual
  mapping:
    identity:
      v: hcim-patient-v2.0.1-2015EN
    map:
      v: NL-CM:0.1.1
    comment:
      v: Patient
  mapping:
    identity:
      v: hcim-patient-v3.0-2016EN
    map:
      v: NL-CM:0.1.1
    comment:
      v: Patient
  mapping:
    identity:
      v: hcim-patient-v3.1-2017EN
    map:
      v: NL-CM:0.1.1
    comment:
      v: Patient
  mapping:
    identity:
      v: hcim-payer-v1.2-2015EN
    map:
      v: NL-CM:1.1.2
    comment:
      v: PayerPerson
  mapping:
    identity:
      v: hcim-payer-v3.0-2016EN
    map:
      v: NL-CM:1.1.2
    comment:
      v: PayerPerson
  mapping:
    identity:
      v: hcim-payer-v3.1-2017EN
    map:
      v: NL-CM:1.1.2
    comment:
      v: PayerPerson
  mapping:
    identity:
      v: hcim-basicelements-v1.0-2017EN
    map:
      v: NL-CM:0.0.3
    comment:
      v: PatientAsInformationSource::Patient
  mapping:
    identity:
      v: hcim-basicelements-v1.0-2017EN
    map:
      v: NL-CM:0.0.8
    comment:
      v: PatientAsAuthor::Patient
  mapping:
    identity:
      v: hcim-basicelements-v1.0-2017EN
    map:
      v: NL-CM:0.0.12
    comment:
      v: Patient
element:
  id:
    v: Patient.id
  path:
    v: Patient.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

v: 1

code:
  v: id
  l: id

v: true

id:
  v: Patient.meta
path:
  v: Patient.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 may 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
    l: Meta
is summary:
  v: true

id:
  v: Patient.implicitRules
path:
  v: Patient.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.
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. 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is modifier:
  v: true
is summary:
  v: true

id:
  v: Patient.language
path:
  v: Patient.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
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Reference
      l: 3.0
      l: .2
      reference:
        v: http://hl7.org/fhir/ValueSet/all-languages|3.0.2
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: extensible
  description:
    v: A human language.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/languages|3.0.2

id:
  v: Patient.text
path:
  v: Patient.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 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.
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 in formation 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
    l: Narrative
condition:
  v: dom-1
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Patient.contained
path:
  v: Patient.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.
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
    l: Resource
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension
path:
  v: Patient.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:preferredPharmacy
path:
  v: Patient.extension
slice name:
  v: preferredPharmacy
short:
  v: References a patient's preferered pharmacy
definition:
  v: Optional Extension Element - found in all resources.
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
alias:
  v: Verwijst naar de voorkeursapotheek van de patiënt
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy|2.0.2
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy|2.0.2
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality
path:
  v: Patient.extension
slice name:
  v: nationality
short:
  v: Nationality
definition:
  v: The nationality of the patient.
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
alias:
  v: Nationaliteit
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-nationality
    l: patient-nationality
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: hcim-nationality-v2.0-2015EN
  map:
    v: NL-CM:7.6.3
  comment:
    v: Nationality
mapping:
  identity:
    v: hcim-nationality-v3.0-2016EN
  map:
    v: NL-CM:7.6.3
  comment:
    v: Nationality
mapping:
  identity:
    v: hcim-nationality-v3.0-2017EN
  map:
    v: NL-CM:7.6.3
  comment:
    v: Nationality

id:
  v: Patient.extension:nationality.id
path:
  v: Patient.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension
path:
  v: Patient.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension:code
path:
  v: Patient.extension.extension
slice name:
  v: code
short:
  v: Nationality Code
definition:
  v: Code representing nationality of patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Patient.extension:nationality.extension:code.id
path:
  v: Patient.extension.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension:code.extension
path:
  v: Patient.extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension:code.url
path:
  v: Patient.extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: code
  l: code
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:code.valueCodeableConcept
path:
  v: Patient.extension.extension.valueCodeableConcept
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: extensible
  description:
    v: Indicates the country of citizenship.
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: .7
    l: .6
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20171231000000|2017-12-31T00:00:00
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:period
path:
  v: Patient.extension.extension
slice name:
  v: period
short:
  v: Nationality Period
definition:
  v: Period when nationality was effective.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Patient.extension:nationality.extension:period.id
path:
  v: Patient.extension.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension:period.extension
path:
  v: Patient.extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:nationality.extension:period.url
path:
  v: Patient.extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: period
  l: period
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:period.valuePeriod
path:
  v: Patient.extension.extension.valuePeriod
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.url
path:
  v: Patient.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/patient-nationality
  l: patient-nationality
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.value[x]
path:
  v: Patient.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: base64Binary
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: code
    l: code
type:
  code:
    v: date
    l: date
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: decimal
    l: decimal
type:
  code:
    v: id
    l: id
type:
  code:
    v: instant
    l: instant
type:
  code:
    v: integer
    l: integer
type:
  code:
    v: markdown
    l: markdown
type:
  code:
    v: oid
    l: oid
type:
  code:
    v: positiveInt
    l: positiveInt
type:
  code:
    v: string
    l: string
type:
  code:
    v: time
    l: time
type:
  code:
    v: unsignedInt
    l: unsignedInt
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: Address
    l: Address
type:
  code:
    v: Age
    l: Age
type:
  code:
    v: Annotation
    l: Annotation
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: Coding
    l: Coding
type:
  code:
    v: ContactPoint
    l: ContactPoint
type:
  code:
    v: Count
    l: Count
type:
  code:
    v: Distance
    l: Distance
type:
  code:
    v: Duration
    l: Duration
type:
  code:
    v: HumanName
    l: HumanName
type:
  code:
    v: Identifier
    l: Identifier
type:
  code:
    v: Money
    l: Money
type:
  code:
    v: Period
    l: Period
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Range
    l: Range
type:
  code:
    v: Ratio
    l: Ratio
type:
  code:
    v: Reference
    l: Reference
type:
  code:
    v: SampledData
    l: SampledData
type:
  code:
    v: Signature
    l: Signature
type:
  code:
    v: Timing
    l: Timing
type:
  code:
    v: Meta
    l: Meta
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legalStatus
path:
  v: Patient.extension
slice name:
  v: legalStatus
short:
  v: legalStatus
definition:
  v: The legal situation that applies to the patient during the intervention. The code of the legal status is based on the Vektis/AZR code list COD232-VEKT Legal Status.
comment:
  v: The concept LegalStatus of the HCIM FreedomRestrictingMeasures plays an important role in the context of mental healthcare (GGZ). This concept will become an independent HCIM with the next release of HCIM (2018 release). The LegalStatus concept and associated ValueSet will be split in two concepts: legal status and representative. These concepts are currently captured in one ValueSet. It is possible to have a legal status AND a representative. Therefore, we allow this extension to have a cardinality of 0..2.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 2
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus|1.0.4
    l: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus|1.0.4
    l: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: hcim-freedomrestrictingmeasures-v3.1-2017EN
  map:
    v: NL-CM:14.3.2
  comment:
    v: LegalStatus

id:
  v: Patient.extension:lifeStance
path:
  v: Patient.extension
slice name:
  v: lifeStance
short:
  v: Optional Extensions Element
definition:
  v: Optional Extension Element - found in all resources.
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
    l: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance|1.0.2
    l: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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://nictiz.nl/fhir/StructureDefinition/zib-LifeStance|1.0.2
    l: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.id
path:
  v: Patient.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.extension
path:
  v: Patient.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.url
path:
  v: Patient.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
  l: zib-LifeStance
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:lifeStance.value[x]
path:
  v: Patient.extension.value[x]
short:
  v: LifeStance
definition:
  v: Patient’s life stance and/or religion.
alias:
  v: Levensovertuiging
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: LevensovertuigingCodelijst
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: .7
    l: .5
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.5.1--20171231000000|2017-12-31T00:00:00
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: hcim-lifestance-v3.1-2017EN
  map:
    v: NL-CM:7.5.2
  comment:
    v: LifeStance

id:
  v: Patient.extension:lifeStance.value[x].id
path:
  v: Patient.extension.value[x].id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.value[x].extension
path:
  v: Patient.extension.value[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.value[x].coding
path:
  v: Patient.extension.value[x].coding
short:
  v: Code defined by a terminology system
definition:
  v: A reference to a code defined by a terminology system.
comment:
  v: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
requirements:
  v: Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CodeableConcept.coding
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.1-8, C*E.10-22
mapping:
  identity:
    v: rim
  map:
    v: union(., ./translation)
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

id:
  v: Patient.extension:lifeStance.value[x].coding.id
path:
  v: Patient.extension.value[x].coding.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.value[x].coding.extension
path:
  v: Patient.extension.value[x].coding.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:lifeStance.value[x].coding.system
path:
  v: Patient.extension.value[x].coding.system
short:
  v: Identity of the terminology system
definition:
  v: The identification of the code system that defines the meaning of the symbol in the code.
comment:
  v: The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
requirements:
  v: Need to be unambiguous about the source of the definition of the symbol.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Coding.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.3
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystem
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

id:
  v: Patient.extension:lifeStance.value[x].coding.version
path:
  v: Patient.extension.value[x].coding.version
short:
  v: Version of the system - if relevant
definition:
  v: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
comment:
  v: Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.version
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.7
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystemVersion
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

id:
  v: Patient.extension:lifeStance.value[x].coding.code
path:
  v: Patient.extension.value[x].coding.code
short:
  v: Symbol in syntax defined by the system
definition:
  v: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
requirements:
  v: Need to refer to a particular code in the system.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Coding.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.1
mapping:
  identity:
    v: rim
  map:
    v: ./code
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

id:
  v: Patient.extension:lifeStance.value[x].coding.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Patient.extension.value[x].coding.display
short:
  v: Representation defined by the system
definition:
  v: A representation of the meaning of the code in the system, following the rules of the system.
requirements:
  v: Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.2 - but note this is not well followed
mapping:
  identity:
    v: rim
  map:
    v: CV.displayName
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

id:
  v: Patient.extension:lifeStance.value[x].coding.userSelected
path:
  v: Patient.extension.value[x].coding.userSelected
short:
  v: If this coding was chosen directly by the user
definition:
  v: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
comment:
  v: Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
requirements:
  v: This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.userSelected
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Sometimes implied by being first
mapping:
  identity:
    v: rim
  map:
    v: CD.codingRationale
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

id:
  v: Patient.extension:lifeStance.value[x].text
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Patient.extension.value[x].text
short:
  v: Plain text representation of the concept
definition:
  v: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
comment:
  v: Very often the text is the same as a displayName of one of the codings.
requirements:
  v: The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CodeableConcept.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.9. But note many systems use C*E.2 for this
mapping:
  identity:
    v: rim
  map:
    v: ./originalText[mediaType/code="text/plain"]/data
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions
path:
  v: Patient.extension
slice name:
  v: legallyCapableMedicalTreatmentDecisions
short:
  v: ext LegallyCapable regarding medical treatment decisions
definition:
  v: An extension to indicate the patient's legal capability regarding medical treatment decisions, and to provide a comment on this capability.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions|1.0.0-rc1
    l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
condition:
  v: ACP-Patient-1
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 758
  comment:
    v: Wilsbekwaamheid m.b.t. medische behandelbeslissingen

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.id
path:
  v: Patient.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension
path:
  v: Patient.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable
path:
  v: Patient.extension.extension
slice name:
  v: legallyCapable
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 759
  comment:
    v: Wilsbekwaamheid m.b.t. medische behandelbeslissingen

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.id
path:
  v: Patient.extension.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.extension
path:
  v: Patient.extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.url
path:
  v: Patient.extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: legallyCapable
  l: legallyCapable
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.value[x]
path:
  v: Patient.extension.extension.value[x]
short:
  v: LegallyCapable
definition:
  v: Indicates the patient's legal capacity (LegallyCapable) regarding medical treatment decisions.
alias:
  v: Wilsbekwaam
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment
path:
  v: Patient.extension.extension
slice name:
  v: legallyCapableComment
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 760
  comment:
    v: Toelichting

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.id
path:
  v: Patient.extension.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.extension
path:
  v: Patient.extension.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.url
path:
  v: Patient.extension.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: legallyCapableComment
  l: legallyCapableComment
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.value[x]
path:
  v: Patient.extension.extension.value[x]
short:
  v: LegallyCapableComment
definition:
  v: A comment regarding the patient's legal capacity regarding medical treatment decisions.
alias:
  v: WilsbekwaamToelichting
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.url
path:
  v: Patient.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
  l: ext-LegallyCapable-MedicalTreatmentDecisions
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:legallyCapableMedicalTreatmentDecisions.value[x]
path:
  v: Patient.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
    l: base64Binary
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: code
    l: code
type:
  code:
    v: date
    l: date
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: decimal
    l: decimal
type:
  code:
    v: id
    l: id
type:
  code:
    v: instant
    l: instant
type:
  code:
    v: integer
    l: integer
type:
  code:
    v: markdown
    l: markdown
type:
  code:
    v: oid
    l: oid
type:
  code:
    v: positiveInt
    l: positiveInt
type:
  code:
    v: string
    l: string
type:
  code:
    v: time
    l: time
type:
  code:
    v: unsignedInt
    l: unsignedInt
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: Address
    l: Address
type:
  code:
    v: Age
    l: Age
type:
  code:
    v: Annotation
    l: Annotation
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: Coding
    l: Coding
type:
  code:
    v: ContactPoint
    l: ContactPoint
type:
  code:
    v: Count
    l: Count
type:
  code:
    v: Distance
    l: Distance
type:
  code:
    v: Duration
    l: Duration
type:
  code:
    v: HumanName
    l: HumanName
type:
  code:
    v: Identifier
    l: Identifier
type:
  code:
    v: Money
    l: Money
type:
  code:
    v: Period
    l: Period
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: Range
    l: Range
type:
  code:
    v: Ratio
    l: Ratio
type:
  code:
    v: Reference
    l: Reference
type:
  code:
    v: SampledData
    l: SampledData
type:
  code:
    v: Signature
    l: Signature
type:
  code:
    v: Timing
    l: Timing
type:
  code:
    v: Meta
    l: Meta
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.modifierExtension
path:
  v: Patient.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. 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.
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.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.identifier
path:
  v: Patient.identifier
slicing:
  discriminator:
    type:
      v: value
    path:
      v: system
  rules:
    v: open
short:
  v: PatientIdentificationNumber
definition:
  v: The Burgerservicenummer or BSN, as one of the possible patient identification numbers, should at least be sent unless there is a reason not to. Reasons for not sending the burgerservicenummer include but are not limited to, research and apps without a contract for processing data (Dutch: bewerkingsovereenkomst).
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
alias:
  v: Identificatienummer
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 18
  comment:
    v: Identificatienummer
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id
mapping:
  identity:
    v: w5
  map:
    v: id
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.7
  comment:
    v: PatientIdentificationNumber
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.7
  comment:
    v: PatientIdentificationNumber
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.7
  comment:
    v: PatientIdentificationNumber
mapping:
  identity:
    v: hcim-basicelements-v1.0-2017EN
  map:
    v: NL-CM:0.0.6
  comment:
    v: IdentificationNumber

id:
  v: Patient.identifier:BSN
path:
  v: Patient.identifier
slice name:
  v: BSN
short:
  v: BSN
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
alias:
  v: BSN
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id
mapping:
  identity:
    v: w5
  map:
    v: id

id:
  v: Patient.identifier:BSN.id
path:
  v: Patient.identifier.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.identifier:BSN.extension
path:
  v: Patient.identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.identifier:BSN.use
path:
  v: Patient.identifier.use
short:
  v: usual | official | temp | secondary (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is modifier:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/identifier-use|3.0.2
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Patient.identifier:BSN.type
path:
  v: Patient.identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierType
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
      l: elementdefinition-isCommonBinding
    value: Boolean
      v: true
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/identifier-type|3.0.2
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Patient.identifier:BSN.system
path:
  v: Patient.identifier.system
short:
  v: The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
requirements:
  v: There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://fhir.nl/fhir/NamingSystem/bsn
  l: bsn
example:
  label:
    v: General
  value: Uri
    v: http://www.acme.com/identifiers/patient
    l: patient
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: Patient.identifier:BSN.value
path:
  v: Patient.identifier.value
short:
  v: BSN (Burgerservicenummer (Dutch person identification number))
definition:
  v: Burgerservicenummer is the Dutch person identification number which is also allowed for use in healthcare.
comment:
  v: The official format according to the 'Logisch Ontwerp BSN 1.4.pdf' is N8..9 and SHALL conform to an 11-proof algorithm. In order to check if the number is 11-proof the number, if N8, SHALL be prefixed with a leading zero. The expected format in FHIR is N9 with leading zero applied to any N8 bsn.
alias:
  v: BSN
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 123456
example:
  label:
    v: Example of a burgerservicenummer
  value: String
    v: 123456782
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Patient.identifier:BSN.period
path:
  v: Patient.identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Patient.identifier:BSN.assigner
path:
  v: Patient.identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

id:
  v: Patient.active
path:
  v: Patient.active
short:
  v: Whether this patient's record is in active use
definition:
  v: This field determines the status of the 'patient' record in the context of the organization that owns the record. Note that the record is not the medical record, but rather the actual patient 'resource'. Obviously when the patient 'resource' is not active, then by extension his medical record might also be inactive. Patient.active='false' may be used discourage use of the record, but that it is kept beause there is (medical) data attached to it. Another use case is a patient moving to a different GP practice. Patient.active would be 'false' in the system of the previous GP.
comment:
  v: Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
requirements:
  v: Need to be able to mark a patient record as not to be used because it was created in error.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.active
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
default value: Boolean
  v: true
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: statusCode
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: w5
  map:
    v: status

id:
  v: Patient.name
path:
  v: Patient.name
short:
  v: NameInformation
definition:
  v: A human's name with the ability to identify parts and usage.
comment:
  v: Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. **Incompatibility note**: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the `.use` element. However, this specification allows for including all alternative representations in the _same_ HumanName instance, with the expectation that the extensions provide enough information for receiving systems to differentiate them. However, this means that contrary to the normal usage of this datatype, repetitions of `.given` names cannot be concatenated to get the full list of given names; the list might be a mix of full names, nicknames and initials. Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically: * Sending and receiving systems SHOULD always use the specified extensions when using th…
requirements:
  v: Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
alias:
  v: Naamgegevens
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
    l: HumanName
  profile:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
example:
  label:
    v: Structured HumanName (preferred above unstructured)
  value: HumanName
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
        l: humanname-assembly-order
      value: Code
        v: NL4
    text:
      v: Irma XXX_Helleman-de Haas
    family:
      v: XXX_Helleman-de Haas
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
    given:
      v: Irma
      extension:
        value: Code
example:
  label:
    v: Unstructured HumanName
  value: HumanName
    text:
      v: Irma XXX_Helleman-de Haas
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: nl-core-humanname-1
  severity:
    v: error
  human:
    v: if you specify a prefix for an own name then an own name is also expected
  expression:
    v: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
  xpath:
    v: not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
constraint:
  key:
    v: nl-core-humanname-2
  severity:
    v: error
  human:
    v: if you specify a voorvoegsel for a partner name then a partner name is also expected
  expression:
    v: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
  xpath:
    v: not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
is summary:
  v: true
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 12
  comment:
    v: Naamgegevens
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 328
  comment:
    v: Naamgegevens
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 13
  comment:
    v: Naamgegevens
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 329
  comment:
    v: Naamgegevens
mapping:
  identity:
    v: v2
  map:
    v: PID-5, PID-9
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: .patient.name
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: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.6
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.6
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.1
  comment:
    v: NameInformation
mapping:
  identity:
    v: BRP
  map:
    v: 02
  comment:
    v: Naam
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN

String
v: XXX_Helleman

String
v: de

String
v: Haas

Code
v: CL

v: NL-CM:0.1.6

v: NameInformation

identity:
  v: hcim-patient-v3.0-2016EN
map:
  v: NL-CM:0.1.6
comment:
  v: NameInformation

identity:
  v: hcim-patient-v3.1-2017EN
map:
  v: NL-CM:0.1.6
comment:
  v: NameInformation

identity:
  v: hcim-payer-v1.2-2015EN
map:
  v: NL-CM:1.1.5
comment:
  v: PayerName

identity:
  v: hcim-payer-v3.0-2016EN
map:
  v: NL-CM:1.1.5
comment:
  v: PayerName

identity:
  v: hcim-payer-v3.1-2017EN
map:
  v: NL-CM:1.1.5
comment:
  v: PayerName

id:
  v: Patient.name.id
path:
  v: Patient.name.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.extension
path:
  v: Patient.name.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.extension:humannameAssemblyOrder
path:
  v: Patient.name.extension
slice name:
  v: humannameAssemblyOrder
short:
  v: Preferred display order of name parts
definition:
  v: A code that represents the preferred display order of the components of this human name.
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
alias:
  v: Voorkeursvolgorde van de naamdelen.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
    l: humanname-assembly-order
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
binding:
  strength:
    v: required
  description:
    v: Human Name Assembly Order
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.34
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.34
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.7
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder

id:
  v: Patient.name.extension:humannameAssemblyOrder.id
path:
  v: Patient.name.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.extension:humannameAssemblyOrder.extension
path:
  v: Patient.name.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.extension:humannameAssemblyOrder.url
path:
  v: Patient.name.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
  l: humanname-assembly-order
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode
path:
  v: Patient.name.extension.valueCode
slice name:
  v: valueCode
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: HumanNameAssemblyOrder
  strength:
    v: required
  description:
    v: A code that represents the preferred display order of the components of a human name
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.use
path:
  v: Patient.name.use
short:
  v: usual | official | temp | nickname | anonymous | old | maiden
definition:
  v: Identifies the purpose for this name.
comment:
  v: 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.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is modifier:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-use|3.0.2
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 222
  comment:
    v: Naamgebruik
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 333
  comment:
    v: Naamgebruik
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: Patient.name.text
path:
  v: Patient.name.text
short:
  v: Text representation of the full name
definition:
  v: A full text representation of the name.
comment:
  v: Can provide both a text representation and structured parts.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: hcim-payer-v1.2-2015EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName
mapping:
  identity:
    v: hcim-payer-v3.0-2016EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName
mapping:
  identity:
    v: hcim-payer-v3.1-2017EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName

id:
  v: Patient.name.family
path:
  v: Patient.name.family
short:
  v: Surname
definition:
  v: 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.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
alias:
  v: Achternaam
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: Patient.name.family.id
path:
  v: Patient.name.family.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Patient.name.family.extension
path:
  v: Patient.name.family.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Patient.name.family.extension:humannameOwnPrefix
path:
  v: Patient.name.family.extension
slice name:
  v: humannameOwnPrefix
short:
  v: Voorvoegsel derived from person's own surname
definition:
  v: 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.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
    l: humanname-own-prefix
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 224
  comment:
    v: Voorvoegsels
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 335
  comment:
    v: Voorvoegsels
mapping:
  identity:
    v: v2
  map:
    v: FN.2
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (VV, R)

id:
  v: Patient.name.family.extension:humannameOwnPrefix.id
path:
  v: Patient.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannameOwnPrefix.extension
path:
  v: Patient.name.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannameOwnPrefix.url
path:
  v: Patient.name.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
  l: humanname-own-prefix
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannameOwnPrefix.valueString:valueString
path:
  v: Patient.name.family.extension.valueString
slice name:
  v: valueString
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannameOwnName
path:
  v: Patient.name.family.extension
slice name:
  v: humannameOwnName
short:
  v: Portion derived from person's own surname
definition:
  v: 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.
comment:
  v: 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".
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
    l: humanname-own-name
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 225
  comment:
    v: Achternaam
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 336
  comment:
    v: Achternaam
mapping:
  identity:
    v: v2
  map:
    v: FN.3
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (BR)

id:
  v: Patient.name.family.extension:humannameOwnName.id
path:
  v: Patient.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannameOwnName.extension
path:
  v: Patient.name.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannameOwnName.url
path:
  v: Patient.name.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
  l: humanname-own-name
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannameOwnName.valueString:valueString
path:
  v: Patient.name.family.extension.valueString
slice name:
  v: valueString
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannamePartnerPrefix
path:
  v: Patient.name.family.extension
slice name:
  v: humannamePartnerPrefix
short:
  v: Voorvoegsel derived from person's partner's surname
definition:
  v: 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.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
    l: humanname-partner-prefix
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 227
  comment:
    v: VoorvoegselsPartner
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 338
  comment:
    v: VoorvoegselsPartner
mapping:
  identity:
    v: v2
  map:
    v: FN.4
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (VV, SP)

id:
  v: Patient.name.family.extension:humannamePartnerPrefix.id
path:
  v: Patient.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannamePartnerPrefix.extension
path:
  v: Patient.name.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannamePartnerPrefix.url
path:
  v: Patient.name.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
  l: humanname-partner-prefix
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannamePartnerPrefix.valueString:valueString
path:
  v: Patient.name.family.extension.valueString
slice name:
  v: valueString
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannamePartnerName
path:
  v: Patient.name.family.extension
slice name:
  v: humannamePartnerName
short:
  v: Portion derived from person's partner's surname
definition:
  v: 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.
comment:
  v: 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".
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
    l: humanname-partner-name
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 228
  comment:
    v: AchternaamPartner
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 339
  comment:
    v: AchternaamPartner
mapping:
  identity:
    v: v2
  map:
    v: FN.5
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (SP)

id:
  v: Patient.name.family.extension:humannamePartnerName.id
path:
  v: Patient.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannamePartnerName.extension
path:
  v: Patient.name.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.name.family.extension:humannamePartnerName.url
path:
  v: Patient.name.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
  l: humanname-partner-name
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.extension:humannamePartnerName.valueString:valueString
path:
  v: Patient.name.family.extension.valueString
slice name:
  v: valueString
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.family.value
path:
  v: Patient.name.family.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type
        l: structuredefinition-json-type
      value: String
        v: string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type
        l: structuredefinition-xml-type
      value: String
        v: xsd:string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type
        l: structuredefinition-rdf-type
      value: String
        v: xsd:string
max length:
  v: 1048576

id:
  v: Patient.name.given
path:
  v: Patient.name.given
short:
  v: Given
definition:
  v: 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.
comment:
  v: 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!
alias:
  v: first name
alias:
  v: middle name
alias:
  v: Voornamen
alias:
  v: Initialen
alias:
  v: Roepnaam
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Given Names appear in the correct order for presenting the name
is summary:
  v: true
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 219
  comment:
    v: Voornamen
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 220
  comment:
    v: Initialen
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 221
  comment:
    v: Roepnaam
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 330
  comment:
    v: Voornamen
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 331
  comment:
    v: Initialen
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 332
  comment:
    v: Roepnaam
mapping:
  identity:
    v: v2
  map:
    v: XPN.2 + XPN.3
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = GIV]
mapping:
  identity:
    v: servd
  map:
    v: ./GivenNames
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.26
  comment:
    v: FirstNames. Qualifier 'BR'
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.35
  comment:
    v: Initials. Qualifier 'IN'
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.27
  comment:
    v: GivenName. Qualifier 'CL'
mapping:
  identity:
    v: BRP
  map:
    v: 02.10
  comment:
    v: Voornamen
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.26
  comment:
    v: FirstNames. Qualifier 'BR'
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.35
  comment:
    v: Initials. Qualifier 'IN'
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.27
  comment:
    v: GivenName. Qualifier 'CL'
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.4
  comment:
    v: FirstNames. Qualifier 'BR'
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.5
  comment:
    v: Initials. Qualifier 'IN'
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.6
  comment:
    v: GivenName. Qualifier 'CL'

id:
  v: Patient.name.given.id
path:
  v: Patient.name.given.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Patient.name.given.extension
path:
  v: Patient.name.given.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
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. 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.
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
    l: Extension

path:
  v: Patient.name.given.extension
slice name:
  v: iso21090EnQualifier
short:
  v: LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
definition:
  v: A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
comment:
  v: Used to indicate additional information about the name part and how it should be used.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
    l: iso21090-EN-qualifier
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: ENXP.qualifier

path:
  v: Patient.name.given.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

path:
  v: Patient.name.given.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

path:
  v: Patient.name.given.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
  l: iso21090-EN-qualifier
mapping:
  identity:
    v: rim
  map:
    v: N/A

path:
  v: Patient.name.given.extension.valueCode
slice name:
  v: valueCode
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EntityNamePartQualifier
  strength:
    v: required
  description:
    v: A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-part-qualifier|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.name.given.value
path:
  v: Patient.name.given.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type
        l: structuredefinition-json-type
      value: String
        v: string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type
        l: structuredefinition-xml-type
      value: String
        v: xsd:string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type
        l: structuredefinition-rdf-type
      value: String
        v: xsd:string
max length:
  v: 1048576

id:
  v: Patient.name.prefix
path:
  v: Patient.name.prefix
short:
  v: Parts that come before the name
definition:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Prefixes appear in the correct order for presenting the name
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.5
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = PFX]
mapping:
  identity:
    v: servd
  map:
    v: ./TitleCode

id:
  v: Patient.name.suffix
path:
  v: Patient.name.suffix
short:
  v: Parts that come after the name
definition:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Suffixes appear in the correct order for presenting the name
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN/4
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = SFX]

id:
  v: Patient.name.period
path:
  v: Patient.name.period
short:
  v: Time period when name was/is in use
definition:
  v: Indicates the period of time when this name was valid for the named person.
requirements:
  v: Allows names to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.13 + XPN.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Patient.telecom
path:
  v: Patient.telecom
short:
  v: ContactInformation
definition:
  v: A contact detail for the individual. Note that there is no support for multiple use values like 'mobile business'.
comment:
  v: A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
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: Patient.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
    l: ContactPoint
  profile:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint|2.0.8
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint
example:
  label:
    v: Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.
  value: ContactPoint
    system:
      v: phone
    value:
      v: +31611234567
    use:
      v: work
example:
  label:
    v: Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.
  value: ContactPoint
    system:
      v: phone
    value:
      v: +31611234567
    use:
      v: mobile
example:
  label:
    v: Primary Home Land Line
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: home
example:
  label:
    v: Temporary Land Line
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: temp
example:
  label:
    v: Primary Work Land Line
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: work
example:
  label:
    v: Primary Home Fax
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: fax
    value:
      v: ...
    use:
      v: home
example:
  label:
    v: Temporary Fax
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: fax
    value:
      v: ...
    use:
      v: temp
example:
  label:
    v: Primary Work Fax
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: fax
    value:
      v: ...
    use:
      v: work
example:
  label:
    v: Primary Home Mobile Phone
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: home
example:
  label:
    v: Temporary Mobile Phone
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: temp
example:
  label:
    v: Primary Work Mobile Phone
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: phone
    value:
      v: ...
    use:
      v: work
example:
  label:
    v: Primary Home Pager
  value: ContactPoint
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
        l: zib-ContactInformation-TelecomType
      value: CodeableConcept
    system:
      v: pager
    value:
      v: ...
    use:
      v: home

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: LL
display:
  v: Land Line

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: LL
display:
  v: Land Line

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: LL
display:
  v: Land Line

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: FAX
display:
  v: Fax

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: FAX
display:
  v: Fax

system:
  v: urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1
  l: 2.16.840.1.113883.2.4.3.11.60.40.4.22.1
code:
  v: FAX
display:
  v: Fax

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: MC
display:
  v: Mobile Phone

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: MC
display:
  v: Mobile Phone

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: MC
display:
  v: Mobile Phone

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: PG
display:
  v: Pager

label:
  v: Temporary Pager
value: ContactPoint
  extension:
    url:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
      l: zib-ContactInformation-TelecomType
    value: CodeableConcept
  system:
    v: pager
  value:
    v: ...
  use:
    v: temp

v: PG

v: Pager

label:
  v: Primary Work Pager
value: ContactPoint
  extension:
    url:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
      l: zib-ContactInformation-TelecomType
    value: CodeableConcept
  system:
    v: pager
  value:
    v: ...
  use:
    v: work

v: PG

v: Pager

label:
  v: Private email address
value: ContactPoint
  system:
    v: email
  use:
    v: home

label:
  v: Work email address
value: ContactPoint
  system:
    v: email
  use:
    v: work

v: ele-1

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() | (children().count() > id.count())
xpath:
  v: @value|f:*|h:div
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  l: Element

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://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint|2.0.8
  l: http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint

v: true

identity:
  v: pall-izppz-zib2017v2025-03-11
map:
  v: 16
comment:
  v: Contactgegevens

identity:
  v: pall-izppz-zib2017v2025-03-11
map:
  v: 17
comment:
  v: Contactgegevens

identity:
  v: v2
map:
  v: PID-13, PID-14, PID-40

identity:
  v: rim
map:
  v: telecom

identity:
  v: cda
map:
  v: .telecom

identity:
  v: rim
map:
  v: n/a

identity:
  v: v2
map:
  v: XTN

identity:
  v: rim
map:
  v: TEL

identity:
  v: servd
map:
  v: ContactPoint

identity:
  v: hcim-contactinformation-v2.0.1-2015EN
map:
  v: NL-CM:0.1.5
comment:
  v: ContactInformation

identity:
  v: hcim-contactinformation-v3.0-2016EN
map:
  v: NL-CM:0.1.5
comment:
  v: ContactInformation

identity:
  v: hcim-contactinformation-v1.0-2017EN
map:
  v: NL-CM:20.6.1
comment:
  v: ContactInformation

identity:
  v: hcim-patient-v2.0.1-2015EN
map:
  v: NL-CM:0.1.5
comment:
  v: ContactInformation

identity:
  v: hcim-patient-v3.0-2016EN
map:
  v: NL-CM:0.1.5
comment:
  v: ContactInformation

identity:
  v: hcim-patient-v3.1-2017EN
map:
  v: NL-CM:0.1.5
comment:
  v: ContactInformation

identity:
  v: hcim-payer-v1.2-2015EN
map:
  v: NL-CM:1.1.12
comment:
  v: TelephoneEmail::ContactInformation

identity:
  v: hcim-payer-v3.0-2016EN
map:
  v: NL-CM:1.1.12
comment:
  v: TelephoneEmail::ContactInformation

identity:
  v: hcim-payer-v3.1-2017EN
map:
  v: NL-CM:1.1.12
comment:
  v: ContactInformation

id:
  v: Patient.gender
path:
  v: Patient.gender
short:
  v: Gender
definition:
  v: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
comment:
  v: The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.
requirements:
  v: Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.
alias:
  v: Geslacht
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: AdministrativeGender
  strength:
    v: required
  description:
    v: The gender of a person used for administrative purposes.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/administrative-gender|3.0.2
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 20
  comment:
    v: Geslacht
mapping:
  identity:
    v: v2
  map:
    v: PID-8
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
mapping:
  identity:
    v: cda
  map:
    v: .patient.administrativeGenderCode
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.9
  comment:
    v: Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.9
  comment:
    v: Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.9
  comment:
    v: Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender

id:
  v: Patient.gender.id
path:
  v: Patient.gender.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Patient.gender.extension
path:
  v: Patient.gender.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
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. 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.
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
    l: Extension

id:
  v: Patient.gender.extension:GeslachtCodelijst
path:
  v: Patient.gender.extension
slice name:
  v: GeslachtCodelijst
short:
  v: Gender
definition:
  v: Patient’s administrative gender.
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
alias:
  v: Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.
alias:
  v: Geslacht
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/code-specification|1.0.4
    l: http://nictiz.nl/fhir/StructureDefinition/code-specification
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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://nictiz.nl/fhir/StructureDefinition/code-specification|1.0.4
    l: http://nictiz.nl/fhir/StructureDefinition/code-specification
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.extension:GeslachtCodelijst.id
path:
  v: Patient.gender.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.gender.extension:GeslachtCodelijst.extension
path:
  v: Patient.gender.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.gender.extension:GeslachtCodelijst.url
path:
  v: Patient.gender.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://nictiz.nl/fhir/StructureDefinition/code-specification
  l: code-specification
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.extension:GeslachtCodelijst.value[x]
path:
  v: Patient.gender.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: extensible
  description:
    v: GeslachtCodelijst
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: .0
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20171231000000|2017-12-31T00:00:00
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.value
path:
  v: Patient.gender.value
representation:
  v: xmlAttr
short:
  v: Primitive value for code
definition:
  v: Primitive value for code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-regex
      l: structuredefinition-regex
    value: String
      v: [^\s]+([\s]?[^\s]+)*
  code:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type
        l: structuredefinition-json-type
      value: String
        v: string
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type
        l: structuredefinition-xml-type
      value: String
        v: xsd:token
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type
        l: structuredefinition-rdf-type
      value: String
        v: xsd:token

id:
  v: Patient.birthDate
path:
  v: Patient.birthDate
short:
  v: Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted.
definition:
  v: The date of birth for the individual.
comment:
  v: At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).
requirements:
  v: Age of the individual drives many clinical processes.
alias:
  v: Geboortedatum
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.birthDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date
is summary:
  v: true
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 19
  comment:
    v: Geboortedatum
mapping:
  identity:
    v: v2
  map:
    v: PID-7
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
mapping:
  identity:
    v: cda
  map:
    v: .patient.birthTime
mapping:
  identity:
    v: loinc
  map:
    v: 21112-8
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.10
  comment:
    v: DateOfBirth
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.10
  comment:
    v: DateOfBirth
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.10
  comment:
    v: DateOfBirth

id:
  v: Patient.deceased[x]
path:
  v: Patient.deceased[x]
short:
  v: DeathIndicator/DateOfDeath
definition:
  v: Indicates if the individual is deceased or not.
comment:
  v: If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
requirements:
  v: The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
alias:
  v: Overlijdensindicator/DatumOverlijden
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: dateTime
    l: dateTime
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PID-30 (bool) and PID-29 (datetime)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.32
  comment:
    v: DeathIndicator
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.32
  comment:
    v: DeathIndicator
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.32
  comment:
    v: DeathIndicator
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.33
  comment:
    v: DateOfDeath
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.33
  comment:
    v: DateOfDeath
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.33
  comment:
    v: DateOfDeath

id:
  v: Patient.address
path:
  v: Patient.address
short:
  v: AddressInformation
definition:
  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 HCIM AddressInformation (v1.0, 2017). 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 HCIM 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 HCIM 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 HCIM code itself should also be included using the AddressType extension. | HCIM |` .ext:AddressType` | `.ext:official` | `.use` | `.type` | |-----------------------------------|:------------------:|:---------------:|:------:|:----------:| | Postal Address/Postadres | _PST_ | | | _postal_ | | Primary Home/Officieel adres | _HP_ | true | _home_ | | | 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 addr…
comment:
  v: Note: address is for postal addresses, not physical locations.
requirements:
  v: May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
alias:
  v: AdresInformatie
alias:
  v: Adresgegevens
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.address
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Address
    l: Address
  profile:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-address|3.0.6
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-address
example:
  label:
    v: Example of a Vacation Home address
  value: Address
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
        l: zib-AddressInformation-AddressType
      value: CodeableConcept
    use:
      v: temp
    line:
      v: Binnenkant 12A Hoog
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
    city:
      v: Amsterdam
    state:
      v: NH
    postal code:
      v: 1000AA
    country:
      v: NLD
example:
  label:
    v: Example of a Primary Home address
  value: Address
    extension:
      url:
        v: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
        l: zib-AddressInformation-AddressType
      value: CodeableConcept
    extension:
      url:
        v: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
        l: nl-core-address-official
      value: Boolean
        v: true
    use:
      v: home
    line:
      v: Binnenkant to 10
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
    city:
      v: Amsterdam
    state:
      v: NH
    postal code:
      v: 1001AA
    country:
      v: NLD
condition:
  v: ele-1
condition:
  v: nl-streetname-if-official-and-other-line-parts
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: nl-streetname-if-official-and-other-line-parts
  requirements:
    v: This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
  severity:
    v: error
  human:
    v: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value
  expression:
    v: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
  xpath:
    v: not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-address|3.0.6
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-address
is summary:
  v: true
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 14
  comment:
    v: Adresgegevens
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  map:
    v: 15
  comment:
    v: Adresgegevens
mapping:
  identity:
    v: v2
  map:
    v: PID-11
mapping:
  identity:
    v: rim
  map:
    v: addr
mapping:
  identity:
    v: cda
  map:
    v: .addr
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: hcim-address-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.4
  comment:
    v: AddressInformation
mapping:
  identity:
    v: hcim-addressinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.4
  comment:
    v: AddressInformation
mapping:
  identity:
    v: hcim-addressinformation-v1.0-2017EN
  map:
    v: NL-CM:20.5.1
  comment:
    v: AddressInformation

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: HV
display:
  v: Vakantie adres

String
v: Binnenkant

String
v: 12

String
v: A

String
v: Hoog

system:
  v: http://hl7.org/fhir/v3/AddressUse
  l: AddressUse
code:
  v: HP
display:
  v: Officieel adres

String
v: Binnenkant

String
v: to

String
v: 10

identity:
  v: hcim-patient-v2.0.1-2015EN
map:
  v: NL-CM:0.1.4
comment:
  v: AddressInformation

identity:
  v: hcim-patient-v3.0-2016EN
map:
  v: NL-CM:0.1.4
comment:
  v: AddressInformation

identity:
  v: hcim-patient-v3.1-2017EN
map:
  v: NL-CM:0.1.4
comment:
  v: AddressInformation

identity:
  v: hcim-payer-v1.2-2015EN
map:
  v: NL-CM:1.1.17
comment:
  v: AddressInformation

identity:
  v: hcim-payer-v3.0-2016EN
map:
  v: NL-CM:1.1.17
comment:
  v: Address

identity:
  v: hcim-payer-v3.1-2017EN
map:
  v: NL-CM:1.1.17
comment:
  v: AddressInformation

id:
  v: Patient.maritalStatus
path:
  v: Patient.maritalStatus
short:
  v: MaritalStatus
definition:
  v: This field contains a patient's most recent marital (civil) status. A person’s marital status according to the terms and definition in the Dutch civil code.
requirements:
  v: Most, if not all systems capture it.
alias:
  v: BurgerlijkeStaat
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.maritalStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: MaritalStatus
  strength:
    v: extensible
  description:
    v: The domestic partnership status of a person.
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: .7
    l: .9
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20171231000000|2017-12-31T00:00:00
mapping:
  identity:
    v: v2
  map:
    v: PID-16
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN]/maritalStatusCode
mapping:
  identity:
    v: cda
  map:
    v: .patient.maritalStatusCode
mapping:
  identity:
    v: hcim-maritalstatus-v1.2.1-2015EN
  map:
    v: NL-CM:7.9.2
  comment:
    v: MaritalStatus
mapping:
  identity:
    v: hcim-maritalstatus-v3.0-2016EN
  map:
    v: NL-CM:7.9.2
  comment:
    v: MaritalStatus
mapping:
  identity:
    v: hcim-maritalstatus-v3.0-2017EN
  map:
    v: NL-CM:7.9.2
  comment:
    v: MaritalStatus
mapping:
  identity:
    v: hcim-familysituation-v1.0-2015EN
  map:
    v: NL-CM:7.13.7
  comment:
    v: FamilySituation
mapping:
  identity:
    v: hcim-familysituation-v3.0-2016EN
  map:
    v: NL-CM:7.13.7
  comment:
    v: FamilySituation
mapping:
  identity:
    v: hcim-familysituation-v3.0-2017EN
  map:
    v: NL-CM:7.13.7
  comment:
    v: FamilySituation

id:
  v: Patient.multipleBirth[x]
path:
  v: Patient.multipleBirth[x]
short:
  v: MultipleBirthIndicator
definition:
  v: Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
comment:
  v: Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
requirements:
  v: For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
alias:
  v: Meerlingindicator
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.multipleBirth[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: integer
    l: integer
mapping:
  identity:
    v: v2
  map:
    v: PID-24 (bool), PID-25 (integer)
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: hcim-patient-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.31
  comment:
    v: MultipleBirthIndicator
mapping:
  identity:
    v: hcim-patient-v3.0-2016EN
  map:
    v: NL-CM:0.1.31
  comment:
    v: MultipleBirthIndicator
mapping:
  identity:
    v: hcim-patient-v3.1-2017EN
  map:
    v: NL-CM:0.1.31
  comment:
    v: MultipleBirthIndicator

id:
  v: Patient.photo
path:
  v: Patient.photo
short:
  v: Image of the patient
definition:
  v: Image of the patient.
requirements:
  v: Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.photo
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Attachment
    l: Attachment
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 - needs a profile
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact
path:
  v: Patient.contact
short:
  v: ContactPerson
definition:
  v: Contacts are related persons in some way, but not all related persons are contacts. The HCIM ContactPerson is designed to deal with both related persons and contacts. An HCIM ContactPerson who is a contact, is expected to have an NL-CM:3.1.2 Role primary contact ('Eerste relatie/contactpersoon') or secondary contact ('Tweede relatie/contactpersoon'). See Patient.contact.relationship in slice 'role'.
comment:
  v: Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
requirements:
  v: Need to track people you can contact about the patient.
alias:
  v: Contactpersoon
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: pat-1
  severity:
    v: error
  human:
    v: SHALL at least contain a contact's details or a reference to an organization
  expression:
    v: name.exists() or telecom.exists() or address.exists() or organization.exists()
  xpath:
    v: exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-patient|2.2.5
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-patient
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: hcim-contactperson-v1.2-2015EN
  map:
    v: NL-CM:3.1.1
  comment:
    v: Contact
mapping:
  identity:
    v: hcim-contactperson-v3.0-2016EN
  map:
    v: NL-CM:3.1.1
  comment:
    v: Contact
mapping:
  identity:
    v: hcim-contactperson-v3.1-2017EN
  map:
    v: NL-CM:3.1.1
  comment:
    v: Contact

id:
  v: Patient.contact.id
path:
  v: Patient.contact.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.extension
path:
  v: Patient.contact.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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.modifierExtension
path:
  v: Patient.contact.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 element, 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.
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
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.relationship
path:
  v: Patient.contact.relationship
slicing:
  discriminator:
    type:
      v: value
    path:
      v: $this
  rules:
    v: open
short:
  v: The kind of relationship
definition:
  v: The nature of the relationship between the patient and the contact person.
requirements:
  v: Used to determine which contact person is the most relevant to approach, depending on circumstances.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactRelationship
  strength:
    v: extensible
  description:
    v: The nature of the relationship between a patient and a contact person for that patient.
  value set: Reference
    l: 2.8
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/v2-0131|2.8.2
mapping:
  identity:
    v: v2
  map:
    v: NK1-7, NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.relationship:relationship
path:
  v: Patient.contact.relationship
slice name:
  v: relationship
short:
  v: Relationship
definition:
  v: The nature of the relationship between the patient and the contact person.
requirements:
  v: Used to determine which contact person is the most relevant to approach, depending on circumstances.
alias:
  v: Relatie
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactRelationship
  strength:
    v: required
  description:
    v: The nature of the relationship between a patient and a contact person for that patient.
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: 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
mapping:
  identity:
    v: v2
  map:
    v: NK1-7, NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: hcim-contactperson-v1.2-2015EN
  map:
    v: NL-CM:3.1.3
  comment:
    v: Relationship
mapping:
  identity:
    v: hcim-contactperson-v3.0-2016EN
  map:
    v: NL-CM:3.1.3
  comment:
    v: Relationship
mapping:
  identity:
    v: hcim-contactperson-v3.1-2017EN
  map:
    v: NL-CM:3.1.3
  comment:
    v: Relationship

id:
  v: Patient.contact.relationship:role
path:
  v: Patient.contact.relationship
slice name:
  v: role
short:
  v: Role
definition:
  v: Expectation is to have at least one of primary contact ('Eerste relatie/contactpersoon') or secondary contact ('Tweede relatie/contactpersoon')
requirements:
  v: Used to determine which contact person is the most relevant to approach, depending on circumstances.
alias:
  v: Rol
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.contact.relationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactRelationship
  strength:
    v: required
  description:
    v: The nature of the relationship between a patient and a contact person for that patient.
  value set: Reference
    l: 2.16
    l: .840
    l: .1
    l: .113883
    l: .2
    l: .4
    l: .3
    l: .11
    l: .60
    l: .40
    l: -20171231000000
    l: 2017
    l: -12
    l: -31
    l: 00
    reference:
      v: 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
mapping:
  identity:
    v: v2
  map:
    v: NK1-7, NK1-3
mapping:
  identity:
    v: rim
  map:
    v: code
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: hcim-contactperson-v1.2-2015EN
  map:
    v: NL-CM:3.1.2
  comment:
    v: Role
mapping:
  identity:
    v: hcim-contactperson-v3.0-2016EN
  map:
    v: NL-CM:3.1.2
  comment:
    v: Role
mapping:
  identity:
    v: hcim-contactperson-v3.1-2017EN
  map:
    v: NL-CM:3.1.2
  comment:
    v: Role

id:
  v: Patient.contact.name
path:
  v: Patient.contact.name
short:
  v: NameInformation
definition:
  v: A human's name with the ability to identify parts and usage.
comment:
  v: Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. **Incompatibility note**: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the `.use` element. However, this specification allows for including all alternative representations in the _same_ HumanName instance, with the expectation that the extensions provide enough information for receiving systems to differentiate them. However, this means that contrary to the normal usage of this datatype, repetitions of `.given` names cannot be concatenated to get the full list of given names; the list might be a mix of full names, nicknames and initials. Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically: * Sending and receiving systems SHOULD always use the specified extensions when using th…
requirements:
  v: Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
alias:
  v: Naamgegevens
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: HumanName
    l: HumanName
  profile:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
example:
  label:
    v: Structured HumanName (preferred above unstructured)
  value: HumanName
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
        l: humanname-assembly-order
      value: Code
        v: NL4
    text:
      v: Irma XXX_Helleman-de Haas
    family:
      v: XXX_Helleman-de Haas
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
    given:
      v: Irma
      extension:
        value: Code
example:
  label:
    v: Unstructured HumanName
  value: HumanName
    text:
      v: Irma XXX_Helleman-de Haas
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: nl-core-humanname-1
  severity:
    v: error
  human:
    v: if you specify a prefix for an own name then an own name is also expected
  expression:
    v: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
  xpath:
    v: not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
constraint:
  key:
    v: nl-core-humanname-2
  severity:
    v: error
  human:
    v: if you specify a voorvoegsel for a partner name then a partner name is also expected
  expression:
    v: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
  xpath:
    v: not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']
  source:
    v: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname|2.0.10
    l: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
mapping:
  identity:
    v: v2
  map:
    v: NK1-2
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: n/a
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: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.6
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.6
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.1
  comment:
    v: NameInformation
mapping:
  identity:
    v: BRP
  map:
    v: 02
  comment:
    v: Naam
mapping:
  identity:
    v: hcim-contactperson-v1.2-2015EN
  map:
    v: NL-CM:3.1.4
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-contactperson-v3.0-2016EN
  map:
    v: NL-CM:3.1.4
  comment:
    v: NameInformation
mapping:
  identity:
    v: hcim-contactperson-v3.1-2017EN
  map:
    v: NL-CM:3.1.4
  comment:
    v: NameInformation

String
v: XXX_Helleman

String
v: de

String
v: Haas

Code
v: CL

id:
  v: Patient.contact.name.id
path:
  v: Patient.contact.name.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.extension
path:
  v: Patient.contact.name.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.extension:humannameAssemblyOrder
path:
  v: Patient.contact.name.extension
slice name:
  v: humannameAssemblyOrder
short:
  v: Preferred display order of name parts
definition:
  v: A code that represents the preferred display order of the components of this human name.
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
alias:
  v: Voorkeursvolgorde van de naamdelen.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
    l: humanname-assembly-order
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
binding:
  strength:
    v: required
  description:
    v: Human Name Assembly Order
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.34
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.34
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.7
  comment:
    v: NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder

id:
  v: Patient.contact.name.extension:humannameAssemblyOrder.id
path:
  v: Patient.contact.name.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.extension:humannameAssemblyOrder.extension
path:
  v: Patient.contact.name.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.extension:humannameAssemblyOrder.url
path:
  v: Patient.contact.name.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
  l: humanname-assembly-order
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCode
path:
  v: Patient.contact.name.extension.valueCode
slice name:
  v: valueCode
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: HumanNameAssemblyOrder
  strength:
    v: required
  description:
    v: A code that represents the preferred display order of the components of a human name
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-assembly-order|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.name.use
path:
  v: Patient.contact.name.use
short:
  v: usual | official | temp | nickname | anonymous | old | maiden
definition:
  v: Identifies the purpose for this name.
comment:
  v: 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.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is modifier:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/name-use|3.0.2
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: Patient.contact.name.text
path:
  v: Patient.contact.name.text
short:
  v: Text representation of the full name
definition:
  v: A full text representation of the name.
comment:
  v: Can provide both a text representation and structured parts.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: hcim-payer-v1.2-2015EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName
mapping:
  identity:
    v: hcim-payer-v3.0-2016EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName
mapping:
  identity:
    v: hcim-payer-v3.1-2017EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName

id:
  v: Patient.contact.name.family
path:
  v: Patient.contact.name.family
short:
  v: Surname
definition:
  v: 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.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
alias:
  v: Achternaam
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: Patient.contact.name.family.id
path:
  v: Patient.contact.name.family.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: Patient.contact.name.family.extension
path:
  v: Patient.contact.name.family.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  rules:
    v: open
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. 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.
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
    l: Extension

id:
  v: Patient.contact.name.family.extension:humannameOwnPrefix
path:
  v: Patient.contact.name.family.extension
slice name:
  v: humannameOwnPrefix
short:
  v: PrefixOwnName
definition:
  v: The prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: VoorvoegselGeslachtsnaam
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
    l: humanname-own-prefix
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: v2
  map:
    v: FN.2
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (VV, R)
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.38
  comment:
    v: Prefix
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.38
  comment:
    v: Prefix
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.11
  comment:
    v: Prefix

id:
  v: Patient.contact.name.family.extension:humannameOwnPrefix.id
path:
  v: Patient.contact.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.family.extension:humannameOwnPrefix.extension
path:
  v: Patient.contact.name.family.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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. 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.name.family.extension:humannameOwnPrefix.url
path:
  v: Patient.contact.name.family.extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
  l: humanname-own-prefix
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.name.family.extension:humannameOwnPrefix.valueString:valueString
path:
  v: Patient.contact.name.family.extension.valueString
slice name:
  v: valueString
short:
  v: Value of extension
definition:
  v: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.name.family.extension:humannameOwnName
path:
  v: Patient.contact.name.family.extension
slice name:
  v: humannameOwnName
short:
  v: OwnName
definition:
  v: The person’s official last name.
comment:
  v: 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. 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".
alias:
  v: extensions
alias:
  v: user content
alias:
  v: Geslachtsnaam
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/humanname-own-name
    l: humanname-own-name
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() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: 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
    l: Extension
mapping:
  identity:
    v: v2
  map:
    v: FN.3
mapping:
  identity:
    v: rim
  map:
    v: ENXP where Qualifiers = (BR)
mapping:
  identity:
    v: hcim-nameinformation-v2.0.1-2015EN
  map:
    v: NL-CM:0.1.24
  comment:
    v: LastName
mapping:
  identity:
    v: hcim-nameinformation-v3.0-2016EN
  map:
    v: NL-CM:0.1.24
  comment:
    v: LastName
mapping:
  identity:
    v: hcim-nameinformation-v1.0.1-2017EN
  map:
    v: NL-CM:20.4.10
  comment:
    v: LastName

id:
  v: Patient.contact.name.family.extension:humannameOwnName.id
path:
  v: Patient.contact.name.family.extension.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim