HdBe-AddressInformation
CBB | Description | Status |
---|---|---|
HdBe-AddressInformation | Address information includes data where a person resides (temporarily, permanently) or where a building is located. This is a partial information model. PurposeAddress information is used for visiting a person or organization and for addressing of mail. | active |
AddressInformation | AddressInformation | ||
Street | 0..1 | string | |
HouseNumber | 0..1 | string | |
HouseNumberLetter | 0..1 | string | |
HouseNumberAddition | 0..1 | string | |
HouseNumberIndication | 0..1 | CodeableConceptBinding | |
Postcode | 0..1 | string | |
PlaceOfResidence | 0..1 | string | |
Municipality | 0..1 | string | |
Country | 0..1 | CodeableConceptBinding | |
AdditionalInformation | 0..1 | string | |
AddressType | 0..1 | CodeableConceptBinding | |
AddressUse | 0..1 | CodeableConceptBinding |
AddressInformation | 0..* | |
AddressInformation.Street | string | 0..1 |
AddressInformation.HouseNumber | string | 0..1 |
AddressInformation.HouseNumberLetter | string | 0..1 |
AddressInformation.HouseNumberAddition | string | 0..1 |
AddressInformation.HouseNumberIndication | CodeableConcept | 0..1 |
AddressInformation.Postcode | string | 0..1 |
AddressInformation.PlaceOfResidence | string | 0..1 |
AddressInformation.Municipality | string | 0..1 |
AddressInformation.Country | CodeableConcept | 0..1 |
AddressInformation.AdditionalInformation | string | 0..1 |
AddressInformation.AddressType | CodeableConcept | 0..1 |
AddressInformation.AddressUse | CodeableConcept | 0..1 |
AddressInformation | |
Definition | Root concept of the AddressInformation partial information model. This root concept contains all data elements of the AddressInformation partial information model. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
AddressInformation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
AddressInformation.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AddressInformation.Street | |
Definition | Street name of the address. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.HouseNumber | |
Definition | House number of the address. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.HouseNumberLetter | |
Definition | A letter following the house number as assigned by the municipal authorities. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.HouseNumberAddition | |
Definition | The letters or signs needed to locate the mailbox, in addition to the house number and letter. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.HouseNumberIndication | |
Definition | The indication used for addresses which do not consist of the usual street name and house number. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | HouseNumberIndication codes HouseNumberIndication (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AddressInformation.Postcode | |
Definition | Postcode of the address. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.PlaceOfResidence | |
Definition | A geographically determined area which forms part of the municipal area. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.Municipality | |
Definition | Municipality of residence. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.Country | |
Definition | Country in which the address is located. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Country ISO codes CountryISO (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AddressInformation.AdditionalInformation | |
Definition | Extra information such as the building name, building number, entrance, route number. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AddressInformation.AddressType | |
Definition | The type of address in question, such as a home address or mailing address. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | AddressType codes AddressType (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AddressInformation.AddressUse | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | AddressUse codes AddressUse (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Example instances
AddressInformation | |
---|---|
Street | 1e Jacob van Campenstr |
HouseNumber | 15 |
HouseNumberLetter | |
HouseNumberAddition | |
HouseNumberIndication | |
Postcode | 1012 NX |
PlaceOfResidence | Hoogmade |
Municipality | Kaag en Braassem |
Country | Nederland |
AdditionalInformation | |
AddressType | both - Postal & Physical (code by AddressType) |
AddressUse | home - Home (code by AddressUse) |
zib AddressInformation-v1.1 difference
Concept | Category | Description |
---|---|---|
HouseNumberIndication |
terminology | Developed the CodeSystem HouseNumberIndication as replacement of the current values and added the CodeSystem to the HouseNumberIndication ValueSet. |
Postcode |
textual | Removed Dutch context. |
PlaceOfResidence |
textual | Removed Dutch context. |
Municipality |
textual | Removed Dutch context. |
Country |
terminology | Removed GBA country codes ValueSet so only ISO country codes are used. |
AddressType |
terminology | Replaced the ValueSet AddressType with FHIR ValueSet AddressType to make the concept use less complex. Also strictened the binding from extensible to required, to align with the FHIR element. |
AddressUse |
element | Added element to align with the FHIR datatype profile. |
AddressUse |
terminology | Used the FHIR AddressUse ValueSet and set the binding to required to align with the FHIR element. |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
HouseNumberIndication | HouseNumberIndication | required | https://fhir.healthdata.be/ValueSet/HouseNumberIndication |
Country | CountryISO | required | https://fhir.healthdata.be/ValueSet/CountryISO |
AddressType | address-type | required | http://hl7.org/fhir/ValueSet/address-type |
AddressUse | address-use | required | http://hl7.org/fhir/ValueSet/address-use |