AddressInformation

CBBStatusURL
HdBe-AddressInformationdrafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-AddressInformation

street0..1string
house_number0..1string
house_number_letter0..1string
house_number_addition0..1string
house_number_indication0..1CodeableConceptBinding
postcode0..1string
place_of_residence0..1string
municipality0..1string
country0..1CodeableConceptBinding
additional_information0..1string
address_type0..1CodeableConceptBinding

address_information0..*
address_information.streetstring0..1
address_information.house_numberstring0..1
address_information.house_number_letterstring0..1
address_information.house_number_additionstring0..1
address_information.house_number_indicationCodeableConcept0..1
address_information.postcodestring0..1
address_information.place_of_residencestring0..1
address_information.municipalitystring0..1
address_information.countryCodeableConcept0..1
address_information.additional_informationstring0..1
address_information.address_typeCodeableConcept0..1



address_information
DefinitionRoot concept of the AddressInformation partial information model. This root concept contains all data elements of the AddressInformation partial information model.
Cardinality0...*
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
address_information.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
address_information.street
DefinitionStreet name of the address.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.house_number
DefinitionHouse number of the address.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.house_number_letter
DefinitionA letter following the house number as assigned by the municipal authorities.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.house_number_addition
DefinitionThe letters or signs needed to locate the mailbox, in addition to the house number and letter.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.house_number_indication
DefinitionThe indication used for addresses which do not consist of the usual street name and house number.
Cardinality0...1
TypeCodeableConcept
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
address_information.postcode
DefinitionPostcode of the address.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.place_of_residence
DefinitionA geographically determined area which forms part of the municipal area.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.municipality
DefinitionMunicipality of residence.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.country
DefinitionCountry in which the address is located.
Cardinality0...1
TypeCodeableConcept
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
address_information.additional_information
DefinitionExtra information such as the building name, building number, entrance, route number.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
address_information.address_type
DefinitionThe type of address in question, such as a home address or mailing address.
Cardinality0...1
TypeCodeableConcept
Binding

AddressType codes

AddressType (extensible)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD

Example instances

address_information
street 1e Jacob van Campenstr
house_number 15
house_number_letter
house_number_addition
house_number_indication
postcode 1012 NX
place_of_residence Hoogmade
municipality Kaag en Braassem
country Nederland
additional_information
address_type Woon-/verblijfadres

zib AddressInformation-v1.1 difference

Concept Category Description
postcode textual Removed Dutch context.
place_of_residence textual Removed Dutch context.
municipality textual Removed Dutch context.
country terminology Removed GBA country codes ValueSet so only ISO country codes are used.



Terminology Bindings

PathNameStrengthURL
house_number_indicationHouseNumberIndicationrequiredhttps://fhir.healthdata.be/ValueSet/HouseNumberIndication
countryCountryISOrequiredhttps://fhir.healthdata.be/ValueSet/CountryISO
address_typeAddressTypeextensiblehttps://fhir.healthdata.be/ValueSet/AddressType