zib-AddressInformation
type: StructureDefinition
node role: treeRoot
id:
  v: zib-AddressInformation
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Address 0..* Address This is an abstract profile. Child profiles: NlcoreAddressInformation AddressInformation addressType 0..1 CodeableConcept Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20200901000000 (extensible) use 0..1 code AddressType Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse. type 0..1 code AddressType Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType. line 0..* string Street name, number, direction & P.O. Box etc. streetName 0..1 string streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName value[x] 1..1 string Street houseNumber 0..1 string houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber value[x] 1..1 string HouseNumber houseNumberLetter-houseNumberAddition 0..1 string buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix <a href="StructureDefinition-zib-AddressInformation-definitions.html#Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]" title="Export: - If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. - If only a HouseNumberLetter is known, send just that. No trailing space is required. - If only a HouseNumberAddition is known, communicate that with a leading space. Import - If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. - If the valu…
url:
  v: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation
version:
  v: 0.9.0
name:
  v: ZibAddressInformation
title:
  v: zib AddressInformation
status:
  v: draft
date:
  v: 2023-10-17T18:06:34+02:00
publisher:
  v: HL7NL
contact:
  name:
    v: HL7NL
  telecom:
    system:
      v: url
    value:
      v: https://hl7.nl
description:
  v: Address information includes data where a person resides (temporarily, permanently) or where a building is located.
purpose:
  v: This Address datatype represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) AddressInformation v1.1 (2020)](https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)).
copyright:
  v: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  uri:
    v: https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)
  name:
    v: zib AddressInformation-v1.1(2020EN)
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
mapping:
  identity:
    v: vcard
  uri:
    v: http://w3.org/vcard
  name:
    v: vCard Mapping
kind:
  v: complex-type
abstract:
  v: true
type:
  v: Address
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Address
  link: http://hl7.org/fhir/StructureDefinition/Address
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Address
    path:
      v: 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…
    alias:
      v: Adresgegevens
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Address
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: XAD
    mapping:
      identity:
        v: rim
      map:
        v: AD
    mapping:
      identity:
        v: servd
      map:
        v: Address
    mapping:
      identity:
        v: zib-addressinformation-v1.1-2020EN
      map:
        v: NL-CM:20.5.1
      comment:
        v: AddressInformation
  element:
    id:
      v: Address.id
    path:
      v: Address.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:
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Address.extension
    path:
      v: Address.extension
    slicing:
      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.

v: string

v: value

v: url

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.

v: extensions

v: user content

v: 0

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension

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

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

v: false

v: false

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

id:
  v: Address.extension:addressType
path:
  v: Address.extension
slice name:
  v: addressType
short:
  v: Optional Extensions Element
definition:
  v: Optional Extension Element - found in all resources.
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-AddressInformation.AddressType
    link: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.use
path:
  v: Address.use
short:
  v: AddressType
definition:
  v: The type of address in question, such as a home address or mailing address.
comment:
  v: Applications can assume that an address is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows an appropriate address to be chosen from a list of many.
alias:
  v: AdresSoort
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value:
    v: home
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 is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
is summary:
  v: true
binding:
  strength:
    v: required
  description:
    v: Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
  value set:
    v: http://hl7.org/fhir/ValueSet/address-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XAD.7
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./AddressPurpose
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.8
  comment:
    v: AddressType

id:
  v: Address.type
path:
  v: Address.type
short:
  v: AddressType
definition:
  v: The type of address in question, such as a home address or mailing address.
comment:
  v: The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
alias:
  v: AdresSoort
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value:
    v: both
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  description:
    v: Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
  value set:
    v: http://hl7.org/fhir/ValueSet/address-type|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XAD.18
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: vcard
  map:
    v: address type parameter
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.8
  comment:
    v: AddressType

id:
  v: Address.text
path:
  v: Address.text
short:
  v: Text representation of the address
definition:
  v: Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value:
    v: 137 Nowhere Street, Erewhon 9132
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
mapping:
  identity:
    v: rim
  map:
    v: ./formatted
mapping:
  identity:
    v: vcard
  map:
    v: address label parameter

id:
  v: Address.line
path:
  v: Address.line
short:
  v: Street name, number, direction & P.O. Box etc.
definition:
  v: This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
comment:
  v: The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]".
min:
  v: 0
max:
  v: *
base:
  path:
    v: Address.line
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
order meaning:
  v: The order in which lines should appear in an address label
example:
  label:
    v: General
  value:
    v: 137 Nowhere Street
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = AL]
mapping:
  identity:
    v: vcard
  map:
    v: street
mapping:
  identity:
    v: servd
  map:
    v: ./StreetAddress (newline delimitted)

id:
  v: Address.line.id
path:
  v: Address.line.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension
path:
  v: Address.line.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:streetName
path:
  v: Address.line.extension
slice name:
  v: streetName
short:
  v: streetName
definition:
  v: streetName.
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/iso21090-ADXP-streetName
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
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: false
mapping:
  identity:
    v: rim
  map:
    v: ADXP[partType=STR]

id:
  v: Address.line.extension:streetName.id
path:
  v: Address.line.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.line.extension:streetName.extension
path:
  v: Address.line.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:streetName.url
path:
  v: Address.line.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/iso21090-ADXP-streetName
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.line.extension:streetName.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: Street
definition:
  v: Street name of the address.
alias:
  v: Straat
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.2
  comment:
    v: Street

id:
  v: Address.line.extension:houseNumber
path:
  v: Address.line.extension
slice name:
  v: houseNumber
short:
  v: houseNumber
definition:
  v: The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
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/iso21090-ADXP-houseNumber
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
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: false
mapping:
  identity:
    v: rim
  map:
    v: ADXP[partType=BNR]

id:
  v: Address.line.extension:houseNumber.id
path:
  v: Address.line.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.line.extension:houseNumber.extension
path:
  v: Address.line.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:houseNumber.url
path:
  v: Address.line.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/iso21090-ADXP-houseNumber
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.line.extension:houseNumber.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: HouseNumber
definition:
  v: House number of the address.
alias:
  v: Huisnummer
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.12
  comment:
    v: HouseNumber

id:
  v: Address.line.extension:houseNumberLetter-houseNumberAddition
path:
  v: Address.line.extension
slice name:
  v: houseNumberLetter-houseNumberAddition
short:
  v: buildingNumberSuffix
definition:
  v: Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number.
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/iso21090-ADXP-buildingNumberSuffix
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
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: false
mapping:
  identity:
    v: rim
  map:
    v: ADXP[partType=BNS]

id:
  v: Address.line.extension:houseNumberLetter-houseNumberAddition.id
path:
  v: Address.line.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.line.extension:houseNumberLetter-houseNumberAddition.extension
path:
  v: Address.line.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:houseNumberLetter-houseNumberAddition.url
path:
  v: Address.line.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/iso21090-ADXP-buildingNumberSuffix
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: HouseNumberLetter / HouseNumberAddition
definition:
  v: Export: - If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. - If only a HouseNumberLetter is known, send just that. No trailing space is required. - If only a HouseNumberAddition is known, communicate that with a leading space. Import - If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. - If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
alias:
  v: Huisnummerletter
alias:
  v: Huisnummertoevoeging
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.11
  comment:
    v: HouseNumberLetter
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.10
  comment:
    v: HouseNumberAddition

id:
  v: Address.line.extension:houseNumberIndication
path:
  v: Address.line.extension
slice name:
  v: houseNumberIndication
short:
  v: additionalLocator
definition:
  v: This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).
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/iso21090-ADXP-additionalLocator
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
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: false
mapping:
  identity:
    v: rim
  map:
    v: ADXP[partType=ADL]

id:
  v: Address.line.extension:houseNumberIndication.id
path:
  v: Address.line.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.line.extension:houseNumberIndication.extension
path:
  v: Address.line.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:houseNumberIndication.url
path:
  v: Address.line.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/iso21090-ADXP-additionalLocator
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.line.extension:houseNumberIndication.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: HouseNumberIndication
definition:
  v: The indication used for addresses which do not consist of the usual street name and house number.
comment:
  v: The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. As a result of this, the coded zib HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
alias:
  v: AanduidingBijNummer
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
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: houseNumberIndication
  severity:
    v: error
  human:
    v: Must have value 'by' or 'to'
  expression:
    v: $this in ('by' | 'to')
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.9
  comment:
    v: HouseNumberIndication

id:
  v: Address.line.extension:additionalInformation
path:
  v: Address.line.extension
slice name:
  v: additionalInformation
short:
  v: unitID
definition:
  v: The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
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/iso21090-ADXP-unitID
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
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: false
mapping:
  identity:
    v: rim
  map:
    v: ADXP[partType=UNID]

id:
  v: Address.line.extension:additionalInformation.id
path:
  v: Address.line.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.line.extension:additionalInformation.extension
path:
  v: Address.line.extension.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.line.extension:additionalInformation.url
path:
  v: Address.line.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/iso21090-ADXP-unitID
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.line.extension:additionalInformation.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: AdditionalInformation
definition:
  v: Extra information such as the building name, building number, entrance, route number.
alias:
  v: AdditioneleInformatie
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.7
  comment:
    v: AdditionalInformation

id:
  v: Address.line.value
path:
  v: Address.line.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value:
      v: [ \r\n\t\S]+
  code:
    v: http://hl7.org/fhirpath/System.String
max length:
  v: 1048576
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.city
path:
  v: Address.city
short:
  v: PlaceOfResidence
definition:
  v: A geographically determined area which forms part of the municipal area. For Dutch places of residence, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).
alias:
  v: Municpality
alias:
  v: Woonplaats
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value:
    v: Erewhon
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.3
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CTY]
mapping:
  identity:
    v: vcard
  map:
    v: locality
mapping:
  identity:
    v: servd
  map:
    v: ./Jurisdiction
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.3
  comment:
    v: PlaceOfResidence

id:
  v: Address.district
path:
  v: Address.district
short:
  v: Municipality
definition:
  v: Municipality of residence. For Dutch municipalities, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).
comment:
  v: District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
alias:
  v: County
alias:
  v: Gemeente
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.district
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value:
    v: Madison
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.9
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT | CPA]
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.4
  comment:
    v: Municipality

id:
  v: Address.state
path:
  v: Address.state
short:
  v: Sub-unit of country (abbreviations ok)
definition:
  v: Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
alias:
  v: Province
alias:
  v: Territory
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.4
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = STA]
mapping:
  identity:
    v: vcard
  map:
    v: region
mapping:
  identity:
    v: servd
  map:
    v: ./Region

id:
  v: Address.postalCode
path:
  v: Address.postalCode
short:
  v: Postcode
definition:
  v: Postcode of the address. In Dutch addresses, preferably use the postcode from the Postcode table (OID: 2.16.840.1.113883.2.4.4.15).
alias:
  v: Zip
alias:
  v: Postcode
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value:
    v: 9132
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.5
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = ZIP]
mapping:
  identity:
    v: vcard
  map:
    v: code
mapping:
  identity:
    v: servd
  map:
    v: ./PostalIdentificationCode
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.6
  comment:
    v: Postcode

id:
  v: Address.country
path:
  v: Address.country
short:
  v: Country (e.g. can be ISO 3166 2 or 3 letter code)
definition:
  v: Country - a nation as commonly understood or generally accepted.
comment:
  v: The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the ext-CodeSpecification extension under `Address.country.extension:countryCode`.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.6
mapping:
  identity:
    v: rim
  map:
    v: AD.part[parttype = CNT]
mapping:
  identity:
    v: vcard
  map:
    v: country
mapping:
  identity:
    v: servd
  map:
    v: ./Country

id:
  v: Address.country.id
path:
  v: Address.country.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.country.extension
path:
  v: Address.country.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.country.extension:countryCode
path:
  v: Address.country.extension
slice name:
  v: countryCode
short:
  v: Optional Extensions Element
definition:
  v: Optional Extension Element - found in all resources.
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
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.country.extension:countryCode.id
path:
  v: Address.country.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.country.extension:countryCode.extension
path:
  v: Address.country.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
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Address.country.extension:countryCode.url
path:
  v: Address.country.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
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Address.country.extension:countryCode.value[x]
path:
  v: Address.country.extension.value[x]
short:
  v: Country
definition:
  v: Country in which the address is located.
alias:
  v: Land
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: required
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
mapping:
  identity:
    v: rim
  map:
    v: N/A
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.5
  comment:
    v: Country

id:
  v: Address.country.value
path:
  v: Address.country.value
representation:
  v: xmlAttr
short:
  v: Primitive value for string
definition:
  v: The actual value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: string.value
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/regex
    value:
      v: [ \r\n\t\S]+
  code:
    v: http://hl7.org/fhirpath/System.String
max length:
  v: 1048576
is modifier:
  v: false
is summary:
  v: false

id:
  v: Address.period
path:
  v: Address.period
short:
  v: Time period when address was/is in use
definition:
  v: Time period when address was/is in use.
requirements:
  v: Allows addresses to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Address.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
example:
  label:
    v: General
  value: Period
    start:
      v: 2010-03-23
    end:
      v: 2010-07-01
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XAD.12 / XAD.13 + XAD.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: Address
  path:
    v: Address
  short:
    v: AddressInformation
  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…
  alias:
    v: Adresgegevens
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.1
    comment:
      v: AddressInformation
element:
  id:
    v: Address.extension:addressType
  path:
    v: Address.extension
  slice name:
    v: addressType
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
      link: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
element:
  id:
    v: Address.use
  path:
    v: Address.use
  short:
    v: AddressType
  definition:
    v: The type of address in question, such as a home address or mailing address.
  alias:
    v: AdresSoort
  binding:
    strength:
      v: required
    description:
      v: Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
    value set:
      v: http://hl7.org/fhir/ValueSet/address-use|4.0.1
      link: 4.0
      link: .1
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.8
    comment:
      v: AddressType
element:
  id:
    v: Address.type
  path:
    v: Address.type
  short:
    v: AddressType
  definition:
    v: The type of address in question, such as a home address or mailing address.
  alias:
    v: AdresSoort
  binding:
    strength:
      v: required
    description:
      v: Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
    value set:
      v: http://hl7.org/fhir/ValueSet/address-type|4.0.1
      link: 4.0
      link: .1
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.8
    comment:
      v: AddressType
element:
  id:
    v: Address.line
  path:
    v: Address.line
  comment:
    v: The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]".
element:
  id:
    v: Address.line.extension:streetName
  path:
    v: Address.line.extension
  slice name:
    v: streetName
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
      link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
element:
  id:
    v: Address.line.extension:streetName.value[x]
  path:
    v: Address.line.extension.value[x]
  short:
    v: Street
  definition:
    v: Street name of the address.
  alias:
    v: Straat
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.2
    comment:
      v: Street
element:
  id:
    v: Address.line.extension:houseNumber
  path:
    v: Address.line.extension
  slice name:
    v: houseNumber
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
      link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
element:
  id:
    v: Address.line.extension:houseNumber.value[x]
  path:
    v: Address.line.extension.value[x]
  short:
    v: HouseNumber
  definition:
    v: House number of the address.
  alias:
    v: Huisnummer
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.12
    comment:
      v: HouseNumber
element:
  id:
    v: Address.line.extension:houseNumberLetter-houseNumberAddition
  path:
    v: Address.line.extension
  slice name:
    v: houseNumberLetter-houseNumberAddition
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
      link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
element:
  id:
    v: Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]
  path:
    v: Address.line.extension.value[x]
  short:
    v: HouseNumberLetter / HouseNumberAddition
  definition:
    v: Export: - If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. - If only a HouseNumberLetter is known, send just that. No trailing space is required. - If only a HouseNumberAddition is known, communicate that with a leading space. Import - If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. - If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
  alias:
    v: Huisnummerletter
  alias:
    v: Huisnummertoevoeging
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.11
    comment:
      v: HouseNumberLetter
  mapping:
    identity:
      v: zib-addressinformation-v1.1-2020EN
    map:
      v: NL-CM:20.5.10
    comment:
      v: HouseNumberAddition

id:
  v: Address.line.extension:houseNumberIndication
path:
  v: Address.line.extension
slice name:
  v: houseNumberIndication
max:
  v: 1
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator

id:
  v: Address.line.extension:houseNumberIndication.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: HouseNumberIndication
definition:
  v: The indication used for addresses which do not consist of the usual street name and house number.
comment:
  v: The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. As a result of this, the coded zib HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
alias:
  v: AanduidingBijNummer
constraint:
  key:
    v: houseNumberIndication
  severity:
    v: error
  human:
    v: Must have value 'by' or 'to'
  expression:
    v: $this in ('by' | 'to')
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.9
  comment:
    v: HouseNumberIndication

id:
  v: Address.line.extension:additionalInformation
path:
  v: Address.line.extension
slice name:
  v: additionalInformation
max:
  v: 1
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
    link: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID

id:
  v: Address.line.extension:additionalInformation.value[x]
path:
  v: Address.line.extension.value[x]
short:
  v: AdditionalInformation
definition:
  v: Extra information such as the building name, building number, entrance, route number.
alias:
  v: AdditioneleInformatie
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.7
  comment:
    v: AdditionalInformation

id:
  v: Address.city
path:
  v: Address.city
short:
  v: PlaceOfResidence
definition:
  v: A geographically determined area which forms part of the municipal area. For Dutch places of residence, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).
alias:
  v: Woonplaats
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.3
  comment:
    v: PlaceOfResidence

id:
  v: Address.district
path:
  v: Address.district
short:
  v: Municipality
definition:
  v: Municipality of residence. For Dutch municipalities, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).
alias:
  v: Gemeente
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.4
  comment:
    v: Municipality

id:
  v: Address.postalCode
path:
  v: Address.postalCode
short:
  v: Postcode
definition:
  v: Postcode of the address. In Dutch addresses, preferably use the postcode from the Postcode table (OID: 2.16.840.1.113883.2.4.4.15).
alias:
  v: Postcode
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.6
  comment:
    v: Postcode

id:
  v: Address.country
path:
  v: Address.country
comment:
  v: The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the ext-CodeSpecification extension under `Address.country.extension:countryCode`.

id:
  v: Address.country.extension:countryCode
path:
  v: Address.country.extension
slice name:
  v: countryCode
max:
  v: 1
type:
  code:
    v: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
    link: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification

id:
  v: Address.country.extension:countryCode.value[x]
path:
  v: Address.country.extension.value[x]
short:
  v: Country
definition:
  v: Country in which the address is located.
alias:
  v: Land
binding:
  strength:
    v: required
  value set:
    v: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
    link: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
mapping:
  identity:
    v: zib-addressinformation-v1.1-2020EN
  map:
    v: NL-CM:20.5.5
  comment:
    v: Country