Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: NlcoreAddressInformation | |||
Copyright/Legal: 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. |
||||
Address information includes data where a person resides (temporarily, permanently) or where a building is located.
A derived profile from zib-AddressInformation to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ZibAddressInformation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address | 0..* | ZibAddressInformation | AddressInformation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | ZibAddressInformation | 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. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | ZibAddressInformation | AddressInformation | |
| id | 0..1 | string | Unique id for inter-element referencing | |
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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. Example General: home |
| 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. Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
 line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| streetName | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |
| value[x] | 1..1 | string | HouseNumberLetter / HouseNumberAddition | |
| houseNumberIndication | 0..1 | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |
| value[x] | 1..1 | string | AdditionalInformation | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | PlaceOfResidence Example General: Erewhon |
| district | Σ | 0..1 | string | Municipality Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postcode Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countryCode | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "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) | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Address.country.extension:countryCode.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| houseNumberIndication | error | Address.line.extension:houseNumberIndication.value[x] | Must have value 'by' or 'to' : $this in ('by' | 'to') |
This structure is derived from ZibAddressInformation
Differential View
This structure is derived from ZibAddressInformation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | ZibAddressInformation | AddressInformation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | ZibAddressInformation | 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. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | ZibAddressInformation | AddressInformation | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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. Example General: home |
| 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. Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| streetName | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |
| value[x] | 1..1 | string | HouseNumberLetter / HouseNumberAddition | |
| houseNumberIndication | 0..1 | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "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 | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |
| value[x] | 1..1 | string | AdditionalInformation | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | PlaceOfResidence Example General: Erewhon |
| district | Σ | 0..1 | string | Municipality Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postcode Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countryCode | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "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) | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Address.country.extension:countryCode.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| houseNumberIndication | error | Address.line.extension:houseNumberIndication.value[x] | Must have value 'by' or 'to' : $this in ('by' | 'to') |
This structure is derived from ZibAddressInformation
Other representations of profile: CSV, Excel, Schematron