Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-AddressInformation

ProfileDescriptionStatusURL
HdBe-AddressInformation

Address information includes data where a person resides (temporarily, permanently) or where a building is located.

drafthttps://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation
Instructions

This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Belgium addresses specifically, according to the CBB AddressInformation. A Belgian 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 Belgium context, the implementer SHOULD in addition use the extension element.

Separate address parts

The first addition is that Belgium addresses make certain address parts separately communicable. These parts are required for use in true Belgian systems when dealing with Belgian addresses, but may not have value for international systems when information gets sent abroad.

Mismatch in CBB and FHIR Datatypes The CBB AddressInformation model defines attributes such as PlaceOfResidence (city), Municipality (district), Postcode (postalCode), and Country (country) as CodeableConcepts, in order to bind them to the specific codes provided by the bpost system, as well as certain nullflavor codes. Conversely, the Address datatype represents these concepts using string data types.

In the context of international and Belgium standards, and considering that these specific codes can be accurately mapped to their corresponding string elements, the defining code system is deemed less relevant for addresses. Therefore, no effort has been made to align the datatypes by adding extensions or other modifications. This approach ensures alignment with international standards without compromising the integrity of the data, and avoids unnecessary complexity in the mapping process.


id0..1string
languageI1..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
value0..1System.String
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1stringBinding
periodΣ I0..1Period

id0..1string
languageI1..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
value0..1System.String
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1stringBinding
periodΣ I0..1Period

id0..1string
languageI1..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueStringstring
value0..1System.String
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1stringBinding
periodΣ I0..1Period

Mapping FHIR profile to CBB

PathmapCBB
AddressAddressInformationHdBe-AddressInformation
Address.useAddressInformation.AddressUseHdBe-AddressInformation
Address.typeAddressInformation.AddressTypeHdBe-AddressInformation
Address.line.extension:streetName.value[x]AddressInformation.StreetHdBe-AddressInformation
Address.line.extension:houseNumber.value[x]AddressInformation.HouseNumberHdBe-AddressInformation
Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]AddressInformation.HouseNumberLetterHdBe-AddressInformation
Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]AddressInformation.HouseNumberAdditionHdBe-AddressInformation
Address.line.extension:houseNumberIndication.value[x]AddressInformation.HouseNumberIndicationHdBe-AddressInformation
Address.line.extension:additionalInformation.value[x]AddressInformation.AdditionalInformationHdBe-AddressInformation
Address.cityAddressInformation.PlaceOfResidenceHdBe-AddressInformation
Address.districtAddressInformation.MunicipalityHdBe-AddressInformation
Address.postalCodeAddressInformation.PostcodeHdBe-AddressInformation
Address.countryAddressInformation.CountryHdBe-AddressInformation

HdBe-NameInformation is a datatype profile and can therefore not have an example of its own. Rather, an example is provided within the example of the HdBe-profile(s) that use this datatype profile.

zib AddressInformation difference

Concept Category Description
Address textual Replaced Dutch context with Belgian specific explanantions. And provided guidance on the mismatch in CBB and FHIR Datatypes for PlaceOfResidence (city), Municipality (district), Postcode (postalCode), and Country (country) which are CodeableConcepts in the CBB, but strings in Address.
use mapping Replaced mapping from CBB element addressType to new CBB element addressUse which aligns the CBB more with the FHIR datatype profile.
type terminology Removed the ConceptMap as the binding from the CBB was replaced by the FHIR ValueSet AddressType, which makes a ConceptMap unnecessary.
city textual Removed Dutch context.
district textual Removed Dutch context.
postalCode textual Removed Dutch context.
line textual Removed Dutch context.
line.extension:houseNumberIndication.value[x] textual Removed Dutch context.
country terminology Replaced valueSet LandCodelijsten with CountryISO and moved binding from country.extension:countryCode.value[x] to country.
country.extension:countryCode.value[x] element Removed extension, and migrated all information and mappings to the country element to align with international and Belgium practices.
extension:addressType element Removed the extension, as the terminology of the CBB was simplified, which makes the extension unnecessary.



Terminology Bindings

PathNameStrengthURLConceptMap
Address.countryCountryISOrequiredhttps://fhir.healthdata.be/ValueSet/CountryISONo bound ConceptMap