plugin-patient
type: StructureDefinition
node role: treeRoot
id:
  v: plugin-patient
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints Patient 0..* NlcorePatient Patient identifier S 1..* Identifier PatientIdentificationNumber active 0..1 boolean Whether this patient's record is in active use Required Pattern: true name S 1..* HumanName NameInformation / PayerName gender S 1..1 code Gender birthDate S 1..1 date DateOfBirth deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not address S 1..* NlcoreAddressInformation AddressInformation Documentation for this format
url:
  v: https://plugin.healthcare/fhir/StructureDefinition/plugin-patient
version:
  v: 0.1.0-ci
name:
  v: PluginPatient
status:
  v: draft
date:
  v: 2024-03-26T18:29:28+01:00
publisher:
  v: PLUGIN
contact:
  name:
    v: PLUGIN
  telecom:
    system:
      v: url
    value:
      v: https://plugin.healthcare
  telecom:
    system:
      v: email
description:
  v: Describes the Patient resource as used by the Dutch PLUGIN project. Inherits from [nl-core-Patient](https://simplifier.net/nictiz-r4-zib2020/nlcorepatient).
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
    code:
      v: 528
    display:
      v: NL
copyright:
  v: Used by permission of the PLUGIN team, all rights reserved Creative Commons License
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: zib-patient-v3.2-2020EN
  uri:
    v: https://zibs.nl/wiki/Patient-v3.2(2020EN)
  name:
    v: zib Patient-v3.2(2020EN)
mapping:
  identity:
    v: zib-nationality-v3.0-2020EN
  uri:
    v: https://zibs.nl/wiki/Nationality-v3.0(2020EN)
  name:
    v: zib Nationality-v3.0(2020EN)
mapping:
  identity:
    v: zib-maritalstatus-v3.1-2020EN
  uri:
    v: https://zibs.nl/wiki/MaritalStatus-v3.1(2020EN)
  name:
    v: zib MaritalStatus-v3.1(2020EN)
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  uri:
    v: https://zibs.nl/wiki/LanguageProficiency-v3.2(2020EN)
  name:
    v: zib LanguageProficiency-v3.2(2020EN)
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  uri:
    v: https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)
  name:
    v: zib ContactInformation-v1.2(2020EN)
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  uri:
    v: https://zibs.nl/wiki/ContactPerson-v3.4(2020EN)
  name:
    v: zib ContactPerson-v3.4(2020EN)
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  uri:
    v: https://zibs.nl/wiki/Payer-v3.1.1(2020EN)
  name:
    v: zib Payer-v3.1.1(2020EN)
kind:
  v: resource
abstract:
  v: false
type:
  v: Patient
base definition:
  v: http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient
  link: http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient
derivation:
  v: constraint
snapshot:
  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: Patient
    alias:
      v: nl-core-Patient
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Patient
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource

v: true

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

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: rim
map:
  v: Patient[classCode=PAT]

identity:
  v: cda
map:
  v: ClinicalDocument.recordTarget.patientRole

identity:
  v: zib-patient-v3.2-2020EN
map:
  v: NL-CM:0.1.1
comment:
  v: Patient

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
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
is summary:
  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 might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages
mapping:
  identity:
    v: rim
  map:
    v: n/a

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

id:
  v: Patient.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension
slice name:
  v: nationality
short:
  v: Nationality
definition:
  v: The nationality of the patient.
comment:
  v: Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the zib cardinality of 0..1.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-nationality
    link: http://hl7.org/fhir/StructureDefinition/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() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.extension:nationality.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:code
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension.extension
slice name:
  v: code
short:
  v: Nationality Code
definition:
  v: Code representing nationality of 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
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.extension:nationality.extension:code.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
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
fixed:
  v: code
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:code.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension.extension.value[x]
short:
  v: Nationality
definition:
  v: Indicates the country of citizenship.
alias:
  v: Nationaliteit
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  strength:
    v: extensible
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-nationality-v3.0-2020EN
  map:
    v: NL-CM:7.6.3
  comment:
    v: Nationality

id:
  v: Patient.extension:nationality.extension:period
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension.extension
slice name:
  v: period
short:
  v: Nationality Period
definition:
  v: Period when nationality was effective.
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.extension:nationality.extension:period.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
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
fixed:
  v: period
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.extension:period.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/patient-nationality
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.extension:nationality.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
type:
  code:
    v: boolean
type:
  code:
    v: canonical
type:
  code:
    v: code
type:
  code:
    v: date
type:
  code:
    v: dateTime
type:
  code:
    v: decimal
type:
  code:
    v: id
type:
  code:
    v: instant
type:
  code:
    v: integer
type:
  code:
    v: markdown
type:
  code:
    v: oid
type:
  code:
    v: positiveInt
type:
  code:
    v: string
type:
  code:
    v: time
type:
  code:
    v: unsignedInt
type:
  code:
    v: uri
type:
  code:
    v: url
type:
  code:
    v: uuid
type:
  code:
    v: Address
type:
  code:
    v: Age
type:
  code:
    v: Annotation
type:
  code:
    v: Attachment
type:
  code:
    v: CodeableConcept
type:
  code:
    v: Coding
type:
  code:
    v: ContactPoint
type:
  code:
    v: Count
type:
  code:
    v: Distance
type:
  code:
    v: Duration
type:
  code:
    v: HumanName
type:
  code:
    v: Identifier
type:
  code:
    v: Money
type:
  code:
    v: Period
type:
  code:
    v: Quantity
type:
  code:
    v: Range
type:
  code:
    v: Ratio
type:
  code:
    v: Reference
type:
  code:
    v: SampledData
type:
  code:
    v: Signature
type:
  code:
    v: Timing
type:
  code:
    v: ContactDetail
type:
  code:
    v: Contributor
type:
  code:
    v: DataRequirement
type:
  code:
    v: Expression
type:
  code:
    v: ParameterDefinition
type:
  code:
    v: RelatedArtifact
type:
  code:
    v: TriggerDefinition
type:
  code:
    v: UsageContext
type:
  code:
    v: Dosage
type:
  code:
    v: Meta
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a

identity:
  v: rim
map:
  v: N/A

id:
  v: Patient.modifierExtension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.identifier
path:
  v: Patient.identifier
slicing:
  discriminator:
    type:
      v: value
    path:
      v: $this
  rules:
    v: open
short:
  v: PatientIdentificationNumber
definition:
  v: The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
alias:
  v: Identificatienummer
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.7
  comment:
    v: PatientIdentificationNumber

id:
  v: Patient.identifier:bsn
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.identifier
slice name:
  v: bsn
short:
  v: An identifier for this patient
definition:
  v: An identifier for this patient.
requirements:
  v: Patients are almost always assigned specific numerical identifiers.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
pattern: Identifier
  system:
    v: http://fhir.nl/fhir/NamingSystem/bsn
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
mapping:
  identity:
    v: rim
  map:
    v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
mapping:
  identity:
    v: servd
  map:
    v: Identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: .id

id:
  v: Patient.active
path:
  v: Patient.active
short:
  v: Whether this patient's record is in active use
definition:
  v: Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
comment:
  v: If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
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
meaning when missing:
  v: This resource is generally assumed to be active if no value is provided for the active element
pattern:
  v: true
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: rim
  map:
    v: statusCode
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.name
path:
  v: Patient.name
slicing:
  discriminator:
    type:
      v: value
    path:
      v: use
  rules:
    v: open
short:
  v: NameInformation / PayerName
definition:
  v: Patient's full name.
comment:
  v: A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
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
alias:
  v: BetalerNaam
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is summary:
  v: true
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: 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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.6
  comment:
    v: NameInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.5
  comment:
    v: PayerName

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

id:
  v: Patient.name:nameInformation-GivenName
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.name
slice name:
  v: nameInformation-GivenName
short:
  v: Name of a human - parts and usage
definition:
  v: This slice represents the name information normally used to address the person.
comment:
  v: This `.name` element represents the Dutch given name ("roepnaam") according to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)). **Note 1**: This element should only contain a person's _unofficial_ name. The official names are represented in one or more other `.name` elements with `.name.use` = _official_. **Note 2**: The examples illustrate how the zib is mapped to FHIR.
requirements:
  v: Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
alias:
  v: nl-core-NameInformation.GivenName
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: HumanName
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName
    link: http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is summary:
  v: true
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: v2
  map:
    v: PID-5, PID-9
mapping:
  identity:
    v: rim
  map:
    v: name
mapping:
  identity:
    v: cda
  map:
    v: .patient.name

id:
  v: Patient.telecom
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.telecom
slicing:
  discriminator:
    type:
      v: profile
    path:
      v: $this
  rules:
    v: open
short:
  v: ContactInformation
definition:
  v: Patient’s telephone number(s) or e-mail address(es).
comment:
  v: The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
alias:
  v: Contactgegevens
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: cpt-2
  severity:
    v: error
  human:
    v: A system is required if a value is provided.
  expression:
    v: value.empty() or system.exists()
  xpath:
    v: not(exists(f:value)) or exists(f:system)
  source:
    v: http://hl7.org/fhir/StructureDefinition/ContactPoint
    link: http://hl7.org/fhir/StructureDefinition/ContactPoint
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: XTN
mapping:
  identity:
    v: rim
  map:
    v: TEL
mapping:
  identity:
    v: servd
  map:
    v: ContactPoint
mapping:
  identity:
    v: v2
  map:
    v: PID-13, PID-14, PID-40
mapping:
  identity:
    v: rim
  map:
    v: telecom
mapping:
  identity:
    v: cda
  map:
    v: .telecom
mapping:
  identity:
    v: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.5
  comment:
    v: ContactInformation
mapping:
  identity:
    v: zib-contactinformation-v1.2-2020EN
  map:
    v: NL-CM:20.6.1
  comment:
    v: ContactInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.12
  comment:
    v: ContactInformation

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

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

id:
  v: Patient.gender
path:
  v: Patient.gender
short:
  v: Gender
definition:
  v: Patient’s administrative gender.
comment:
  v: The gender might 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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, 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, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
requirements:
  v: Needed for identification of the individual, in combination with (at least) name and birth date.
alias:
  v: Geslacht
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: AdministrativeGender
  strength:
    v: required
  description:
    v: Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
  value set:
    v: http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    link: 4.0
    link: .1
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
      value:
        v: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
        link: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.9
  comment:
    v: Gender

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

id:
  v: Patient.gender.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.gender.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.extension:genderCodelist
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.gender.extension
slice name:
  v: genderCodelist
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
    link: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.gender.extension:genderCodelist.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.extension:genderCodelist.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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.gender.extension:genderCodelist.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.gender.extension.value[x]
short:
  v: Gender
definition:
  v: Patient’s administrative gender.
alias:
  v: Geslacht
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  strength:
    v: required
  description:
    v: GeslachtCodelijst
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.9
  comment:
    v: Gender

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-fhir-type
    value:
      v: code
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value:
      v: [^\s]+(\s[^\s]+)*
  code:
    v: http://hl7.org/fhirpath/System.String
max length:
  v: 1048576

id:
  v: Patient.birthDate
path:
  v: Patient.birthDate
short:
  v: DateOfBirth
definition:
  v: Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted.
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 maternity/infant care systems).
requirements:
  v: Age of the individual drives many clinical processes.
alias:
  v: Geboortedatum
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.birthDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.10
  comment:
    v: DateOfBirth

id:
  v: Patient.deceased[x]
path:
  v: Patient.deceased[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  ordered:
    v: false
  rules:
    v: closed
short:
  v: Indicates if the individual is deceased or not
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.
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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
type:
  code:
    v: dateTime
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: 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.
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
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

id:
  v: Patient.deceased[x]:deceasedBoolean
path:
  v: Patient.deceased[x]
slice name:
  v: deceasedBoolean
short:
  v: DeathIndicator
definition:
  v: An indication stating whether the patient has died.
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.
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
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: 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.
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.32
  comment:
    v: DeathIndicator

id:
  v: Patient.deceased[x]:deceasedDateTime
path:
  v: Patient.deceased[x]
slice name:
  v: deceasedDateTime
short:
  v: DateOfDeath
definition:
  v: The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.
comment:
  v: The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.
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: DatumOverlijden
alias:
  v: OverlijdensIndicator
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.deceased[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: 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.
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.33
  comment:
    v: DateOfDeath
mapping:
  identity:
    v: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.32
  comment:
    v: DeathIndicator

id:
  v: Patient.address
path:
  v: Patient.address
short:
  v: AddressInformation
definition:
  v: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
comment:
  v: This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the [zib AddressInformation v1.1 (2020)](https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. **Separate address parts** The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. **Custom address types** The second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse> and <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType> as well). The code from the zib should also be included using the extension on `Address.extension:addressType`. | zib | .ext:addressType | .use | .type | |-----------------------------------|------------------|------|----------| | Postal Address/Postadres | PST | | postal | | Primary Home/Officieel adres | HP | home | both | | Visit Address/Woon-/verblijfadres | PHYS | home | physical | | Temporary Address/Tijdelijk adres | TMP | temp | | | Work Place/Werkadres | WP | work | | | Vacation Home/Vakantie adres | HV | temp | | If `Address.type` is _both_ then this is to be understood as a dual purpose address (post…
requirements:
  v: May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
alias:
  v: Adresgegevens
alias:
  v: nl-core-AddressInformation
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.address
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Address
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation
    link: http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is summary:
  v: true
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: v2
  map:
    v: PID-11
mapping:
  identity:
    v: rim
  map:
    v: addr
mapping:
  identity:
    v: cda
  map:
    v: .addr
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.1
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-patient-v3.2-2020EN
  map:
    v: NL-CM:0.1.4
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-payer-v3.1.1-2020EN
  map:
    v: NL-CM:1.1.17
  comment:
    v: AddressInformation

id:
  v: Patient.maritalStatus
path:
  v: Patient.maritalStatus
short:
  v: MaritalStatus
definition:
  v: A person’s marital status according to the terms and definition in the Dutch civil code.
comment:
  v: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: MaritalStatus
  strength:
    v: required
  description:
    v: BurgerlijkeStaatCodelijst
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
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: zib-maritalstatus-v3.1-2020EN
  map:
    v: NL-CM:7.9.2
  comment:
    v: MaritalStatus

id:
  v: Patient.multipleBirth[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.multipleBirth[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  rules:
    v: open
short:
  v: Whether patient is part of a multiple birth
definition:
  v: Indicates whether the patient is part of a multiple (boolean) 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 triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.multipleBirth[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
type:
  code:
    v: integer
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
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

id:
  v: Patient.multipleBirth[x]:multipleBirthBoolean
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.multipleBirth[x]
slice name:
  v: multipleBirthBoolean
short:
  v: MultipleBirthIndicator
definition:
  v: An indication stating whether the patient is of a multiple birth.
comment:
  v: Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-patient-v3.2-2020EN
  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.
comment:
  v: Guidelines: * Use id photos, not clinical photos. * Limit dimensions to thumbnail. * Keep byte count low to ease resource updates.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: att-1
  severity:
    v: error
  human:
    v: If the Attachment has data, it SHALL have a contentType
  expression:
    v: data.empty() or contentType.exists()
  xpath:
    v: not(exists(f:data)) or exists(f:contentType)
  source:
    v: http://hl7.org/fhir/StructureDefinition/Attachment
    link: http://hl7.org/fhir/StructureDefinition/Attachment
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: ED/RP
mapping:
  identity:
    v: rim
  map:
    v: ED
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: Contact
definition:
  v: A contact party (e.g. guardian, partner, friend) for the patient.
comment:
  v: Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: * The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile <http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson>. * Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable. The nl-core-ContactPerson can be referenced using the extension in `contact:contactPerson`.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: 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://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
mapping:
  identity:
    v: rim
  map:
    v: n/a
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: zib-contactperson-v3.4-2020EN
  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: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Patient.contact.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.extension:contactPerson
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.extension
slice name:
  v: contactPerson
short:
  v: This contact may have further details in this RelatedPerson
definition:
  v: In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate.
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
    link: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.contact.extension:contactPerson.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.extension:contactPerson.url
path:
  v: Patient.contact.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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.contact.extension:contactPerson.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.extension.value[x]
short:
  v: Contact
definition:
  v: Reference to an [nl-core-ContactPerson](http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson) instance containing the full details for the current contact.
alias:
  v: Contactpersoon
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  target profile:
    v: http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson
    link: http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.1
  comment:
    v: Contact

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

id:
  v: Patient.contact.relationship
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
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.
comment:
  v: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ContactRelationship
  strength:
    v: extensible
  description:
    v: The nature of the relationship between a patient and a contact person for that patient.
  value set:
    v: http://hl7.org/fhir/ValueSet/patient-contactrelationship
    link: http://hl7.org/fhir/ValueSet/patient-contactrelationship
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
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:role
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.relationship
slice name:
  v: role
short:
  v: Role
definition:
  v: Defines the role of the contact in relation to the patient.
comment:
  v: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ContactRelationship
  strength:
    v: required
  description:
    v: RolCodelijst
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
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: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.2
  comment:
    v: Role

id:
  v: Patient.contact.relationship:relationship
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.contact.relationship
slice name:
  v: relationship
short:
  v: Relationship
definition:
  v: Defines the contact’s familial relationship to the patient.
comment:
  v: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
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
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ContactRelationship
  strength:
    v: required
  description:
    v: RelatieCodelijst
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
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: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.3
  comment:
    v: Relationship

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

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

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

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

id:
  v: Patient.contact.address
path:
  v: Patient.contact.address
short:
  v: AddressInformation
definition:
  v: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
comment:
  v: This element can and should not completely capture the AddressInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of [nl-core-ContactPerson](http://nictiz.nl/fhir/StructureDefintion/nl-core-ContactPerson), which can then be referenced from this resource. See the comment on `Patient.contact` for more information.
requirements:
  v: Need to keep track where the contact person can be contacted per postal mail or visited.
alias:
  v: Adresgegevens
alias:
  v: nl-core-AddressInformation
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.address
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Address
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation
    link: http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
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: v2
  map:
    v: NK1-4
mapping:
  identity:
    v: rim
  map:
    v: addr
mapping:
  identity:
    v: cda
  map:
    v: n/a
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.1
  comment:
    v: AddressInformation
mapping:
  identity:
    v: zib-contactperson-v3.4-2020EN
  map:
    v: NL-CM:3.1.5
  comment:
    v: AddressInformation

id:
  v: Patient.contact.gender
path:
  v: Patient.contact.gender
short:
  v: male | female | other | unknown
definition:
  v: Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
requirements:
  v: Needed to address the person correctly.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.gender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: AdministrativeGender
  strength:
    v: required
  description:
    v: The gender of a person used for administrative purposes.
  value set:
    v: http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: NK1-15
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.organization
path:
  v: Patient.contact.organization
short:
  v: Organization that is associated with the contact
definition:
  v: Organization on behalf of which the contact is acting or for which the contact is working.
comment:
  v: References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
requirements:
  v: For guardians or business related contacts, the organization is relevant.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.organization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
condition:
  v: ele-1
condition:
  v: pat-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ref-1
  severity:
    v: error
  human:
    v: SHALL have a contained resource if a local reference is provided
  expression:
    v: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  xpath:
    v: not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Reference
    link: http://hl7.org/fhir/StructureDefinition/Reference
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
mapping:
  identity:
    v: v2
  map:
    v: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
mapping:
  identity:
    v: rim
  map:
    v: scoper
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.contact.period
path:
  v: Patient.contact.period
short:
  v: The period during which this contact person or organization is valid to be contacted relating to this patient
definition:
  v: The period during which this contact person or organization is valid to be contacted relating to this patient.
comment:
  v: A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.contact.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    link: http://hl7.org/fhir/StructureDefinition/Period
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: rim
  map:
    v: effectiveTime
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.communication
path:
  v: Patient.communication
short:
  v: LanguageProficiency
definition:
  v: A language which may be used to communicate with the patient about his or her health.
comment:
  v: If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
requirements:
  v: If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.
alias:
  v: Taalvaardigheid
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.communication
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: LanguageCommunication
mapping:
  identity:
    v: cda
  map:
    v: patient.languageCommunication
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.1
  comment:
    v: LanguageProficiency

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

id:
  v: Patient.communication.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension
slice name:
  v: languageControl
short:
  v: LanguageControlListening / LanguageControlSpeaking / LanguageControlReading
definition:
  v: The ability to understand spoken text in the language in question. The ability to express oneself in spoken language. The ability to understand written text in he language in question.
comment:
  v: The zib concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captured using a core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping: * LanguageControlListening maps to code 'RSP' (Received spoken) * LanguageControlReading maps to code 'RWR' (Received written) * LanguageControlSpeaking maps to code 'ESP' (Expressed spoken)
alias:
  v: extensions
alias:
  v: user content
alias:
  v: TaalvaardigheidBegrijpen
alias:
  v: TaalvaardigheidSpreken
alias:
  v: TaalvaardigheidLezen
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/patient-proficiency
    link: http://hl7.org/fhir/StructureDefinition/patient-proficiency
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.6
  comment:
    v: LanguageControlListening
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.7
  comment:
    v: LanguageControlSpeaking
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.8
  comment:
    v: LanguageControlReading

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

id:
  v: Patient.communication.extension:languageControl.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 2
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:level
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.extension
slice name:
  v: level
short:
  v: The proficiency level of the communication
definition:
  v: How well the patient can communicate this communication (good, poor, etc.).
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: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.communication.extension:languageControl.extension:level.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:level.url
path:
  v: Patient.communication.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
fixed:
  v: level
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:level.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
comment:
  v: The zib ValueSets TaalvaardigheidBegrijpenCodelijst, TaalvaardigheidSprekenCodelijst and TaalvaardigheidLezenCodelijst are equal to the default FHIR ValueSet.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ProficiencyLevel
  strength:
    v: required
  description:
    v: The proficiency level for the communication.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
    link: http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:type
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.extension
slice name:
  v: type
short:
  v: The proficiency type of the communication
definition:
  v: What type of communication for the proficiency (spoken, written, etc.).
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: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.communication.extension:languageControl.extension:type.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:type.url
path:
  v: Patient.communication.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
fixed:
  v: type
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.extension:type.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: proficiencyType
  strength:
    v: preferred
  description:
    v: The proficiency type for the communication.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
    link: http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.url
path:
  v: Patient.communication.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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://hl7.org/fhir/StructureDefinition/patient-proficiency
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:languageControl.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.value[x]
short:
  v: Value of extension
definition:
  v: Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
type:
  code:
    v: boolean
type:
  code:
    v: canonical
type:
  code:
    v: code
type:
  code:
    v: date
type:
  code:
    v: dateTime
type:
  code:
    v: decimal
type:
  code:
    v: id
type:
  code:
    v: instant
type:
  code:
    v: integer
type:
  code:
    v: markdown
type:
  code:
    v: oid
type:
  code:
    v: positiveInt
type:
  code:
    v: string
type:
  code:
    v: time
type:
  code:
    v: unsignedInt
type:
  code:
    v: uri
type:
  code:
    v: url
type:
  code:
    v: uuid
type:
  code:
    v: Address
type:
  code:
    v: Age
type:
  code:
    v: Annotation
type:
  code:
    v: Attachment
type:
  code:
    v: CodeableConcept
type:
  code:
    v: Coding
type:
  code:
    v: ContactPoint
type:
  code:
    v: Count
type:
  code:
    v: Distance
type:
  code:
    v: Duration
type:
  code:
    v: HumanName
type:
  code:
    v: Identifier
type:
  code:
    v: Money
type:
  code:
    v: Period
type:
  code:
    v: Quantity
type:
  code:
    v: Range
type:
  code:
    v: Ratio
type:
  code:
    v: Reference
type:
  code:
    v: SampledData
type:
  code:
    v: Signature
type:
  code:
    v: Timing
type:
  code:
    v: ContactDetail
type:
  code:
    v: Contributor
type:
  code:
    v: DataRequirement
type:
  code:
    v: Expression
type:
  code:
    v: ParameterDefinition
type:
  code:
    v: RelatedArtifact
type:
  code:
    v: TriggerDefinition
type:
  code:
    v: UsageContext
type:
  code:
    v: Dosage
type:
  code:
    v: Meta
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a

identity:
  v: rim
map:
  v: N/A

id:
  v: Patient.communication.extension:communicationDetails
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension
slice name:
  v: communicationDetails
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: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
    link: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:comment
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension
slice name:
  v: comment
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: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
    link: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.communication.extension:comment.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:comment.url
path:
  v: Patient.communication.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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Patient.communication.extension:comment.value[x]
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.communication.extension.value[x]
short:
  v: Comment
definition:
  v: A comment on the linguistic proficiency. When using sign language, this field can be used to clarify, for example, which sign language is used. This can be informative, as there is not always a one-to-one relationship between the spoken language and sign language.
alias:
  v: Toelichting
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.5
  comment:
    v: Comment

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

id:
  v: Patient.communication.language
path:
  v: Patient.communication.language
short:
  v: CommunicationLanguage
definition:
  v: The language of communication.
comment:
  v: The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
requirements:
  v: Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
alias:
  v: CommunicatieTaal
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.communication.language
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  strength:
    v: required
  description:
    v: CommunicatieTaalCodelijst
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: CE/CNE/CWE
mapping:
  identity:
    v: rim
  map:
    v: CD
mapping:
  identity:
    v: orim
  map:
    v: fhir:CodeableConcept rdfs:subClassOf dt:CD
mapping:
  identity:
    v: v2
  map:
    v: PID-15, LAN-2
mapping:
  identity:
    v: rim
  map:
    v: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
mapping:
  identity:
    v: cda
  map:
    v: .languageCode
mapping:
  identity:
    v: zib-languageproficiency-v3.2-2020EN
  map:
    v: NL-CM:7.12.3
  comment:
    v: CommunicationLanguage

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

id:
  v: Patient.generalPractitioner
path:
  v: Patient.generalPractitioner
short:
  v: A reference from one resource to another
definition:
  v: A reference from one resource to another.
comment:
  v: Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.
alias:
  v: careProvider
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.generalPractitioner
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference
    link: http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    link: http://hl7.org/fhir/StructureDefinition/PractitionerRole
  target profile:
    v: http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole
    link: http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ref-1
  severity:
    v: error
  human:
    v: SHALL have a contained resource if a local reference is provided
  expression:
    v: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  xpath:
    v: not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Reference
    link: http://hl7.org/fhir/StructureDefinition/Reference
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
mapping:
  identity:
    v: v2
  map:
    v: PD1-4
mapping:
  identity:
    v: rim
  map:
    v: subjectOf.CareEvent.performer.AssignedEntity
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.managingOrganization
path:
  v: Patient.managingOrganization
short:
  v: Organization that is the custodian of the patient record
definition:
  v: Organization that is the custodian of the patient record.
comment:
  v: There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
requirements:
  v: Need to know who recognizes this patient record, manages and updates it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.managingOrganization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ref-1
  severity:
    v: error
  human:
    v: SHALL have a contained resource if a local reference is provided
  expression:
    v: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  xpath:
    v: not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Reference
    link: http://hl7.org/fhir/StructureDefinition/Reference
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
mapping:
  identity:
    v: rim
  map:
    v: scoper
mapping:
  identity:
    v: cda
  map:
    v: .providerOrganization

id:
  v: Patient.link
path:
  v: Patient.link
short:
  v: Link to another patient resource that concerns the same actual person
definition:
  v: Link to another patient resource that concerns the same actual patient.
comment:
  v: There is no assumption that linked patient records have mutual links.
requirements:
  v: There are multiple use cases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.link
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: outboundLink
mapping:
  identity:
    v: cda
  map:
    v: n/a

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

id:
  v: Patient.link.extension
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: normative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
  value:
    v: 4.0.0
path:
  v: Patient.link.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

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

id:
  v: Patient.link.other
path:
  v: Patient.link.other
short:
  v: The other patient or related person resource that the link refers to
definition:
  v: The other patient resource that the link refers to.
comment:
  v: Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.link.other
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
    value:
      v: false
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ref-1
  severity:
    v: error
  human:
    v: SHALL have a contained resource if a local reference is provided
  expression:
    v: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  xpath:
    v: not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Reference
    link: http://hl7.org/fhir/StructureDefinition/Reference
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
mapping:
  identity:
    v: v2
  map:
    v: PID-3, MRG-1
mapping:
  identity:
    v: rim
  map:
    v: id
mapping:
  identity:
    v: cda
  map:
    v: n/a

id:
  v: Patient.link.type
path:
  v: Patient.link.type
short:
  v: replaced-by | replaces | refer | seealso
definition:
  v: The type of link between this patient resource and another patient resource.
comment:
  v: Note that FHIR strings SHALL NOT exceed 1MB in size
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.link.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: LinkType
  strength:
    v: required
  description:
    v: The type of link between this patient resource and another patient resource.
  value set:
    v: http://hl7.org/fhir/ValueSet/link-type|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: typeCode
mapping:
  identity:
    v: cda
  map:
    v: n/a

element:
  id:
    v: Patient
  path:
    v: Patient
element:
  id:
    v: Patient.identifier
  path:
    v: Patient.identifier
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Patient.active
  path:
    v: Patient.active
  pattern:
    v: true
element:
  id:
    v: Patient.name
  path:
    v: Patient.name
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Patient.gender
  path:
    v: Patient.gender
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Patient.birthDate
  path:
    v: Patient.birthDate
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Patient.deceased[x]
  path:
    v: Patient.deceased[x]
  must support:
    v: true
element:
  id:
    v: Patient.address
  path:
    v: Patient.address
  min:
    v: 1
  must support:
    v: true