Name Flags Card. Type Description & Constraints 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 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.">value[x] 1..1 string HouseNumberLetter / HouseNumberAddition houseNumberIndication 0..1 string additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator value[x] C 1..1 string HouseNumberIndication houseNumberIndication: Must have value 'by' or 'to' additionalInformation 0..1 string unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID value[x] 1..1 string AdditionalInformation city 0..1 string PlaceOfResidence district 0..1 string Municipality postalCode 0..1 string Postcode country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code) countryCode 0..1 CodeableConcept Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification value[x] 0..1 CodeableConcept Country Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000 (required) Documentation for this format
Address information includes data where a person resides (temporarily, permanently) or where a building is located.
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 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.
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.
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 (postal and physical), unless a specific _postal_ type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. Note: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Optional Extension Element - found in all resources.
The type of address in question, such as a home address or mailing address.
Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Allows an appropriate address to be chosen from a list of many.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
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).
Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
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.
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.
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
Street name, number, direction & P.O. Box etc.
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
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]".
The order in which lines should appear in an address label
XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
unique id for the element within a resource (for internal references)
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Source of the definition for the extension code - a logical name or a URL.
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.
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.
Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number.
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.
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).
The indication used for addresses which do not consist of the usual street name and house number.
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').
The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
Extra information such as the building name, building number, entrance, route number.
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).
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).
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.
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).
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).
Country (e.g. can be ISO 3166 2 or 3 letter code)
Country - a nation as commonly understood or generally accepted.
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`.
Country in which the address is located.
Allows addresses to be placed in historical context.