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

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. Purpose Address information is used for visiting a person or organization and for addressing of mail.	active

CBB

Description

Status

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

Purpose

Address information is used for visiting a person or organization and for addressing of mail.

active

AddressInformation			AddressInformation	Element id AddressInformation Short description AddressInformation Definition Root concept of the AddressInformation partial information model. This root concept contains all data elements of the AddressInformation partial information model. Data type AddressInformation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id AddressInformation.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AddressInformation.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
Street		0..1	string	Element id AddressInformation.Street Short description Street Definition Street name of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HouseNumber		0..1	string	Element id AddressInformation.HouseNumber Short description HouseNumber Definition House number of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HouseNumberLetter		0..1	string	Element id AddressInformation.HouseNumberLetter Short description HouseNumberLetter Definition A letter following the house number as assigned by the municipal authorities. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HouseNumberAddition		0..1	string	Element id AddressInformation.HouseNumberAddition Short description HouseNumberAddition Definition The letters or signs needed to locate the mailbox, in addition to the house number and letter. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HouseNumberIndication		0..1	CodeableConceptBinding	Element id AddressInformation.HouseNumberIndication Short description HouseNumberIndication Definition The indication used for addresses which do not consist of the usual street name and house number. 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. Data type CodeableConcept Binding HouseNumberIndication codes HouseNumberIndication (required) Constraints 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
Postcode		0..1	CodeableConceptBinding	Element id AddressInformation.Postcode Short description Postcode Definition Postcode of the address. 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. Data type CodeableConcept Binding Postcode codes Postcode (required) Constraints 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
PlaceOfResidence		0..1	CodeableConceptBinding	Element id AddressInformation.PlaceOfResidence Short description PlaceOfResidence Definition A geographically determined area which forms part of the municipal area. 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. Data type CodeableConcept Binding PlaceOfResidence codes PlaceOfResidence (required) Constraints 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
Municipality		0..1	CodeableConceptBinding	Element id AddressInformation.Municipality Short description Municipality Definition Municipality of residence. 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. Data type CodeableConcept Binding Municipality codes Municipality (required) Constraints 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
Country		0..1	CodeableConceptBinding	Element id AddressInformation.Country Short description Country Definition Country in which the address is located. 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. Data type CodeableConcept Binding Country ISO codes CountryISO (required) Constraints 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
AdditionalInformation		0..1	string	Element id AddressInformation.AdditionalInformation Short description AdditionalInformation Definition Extra information such as the building name, building number, entrance, route number. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
AddressType		0..1	CodeableConceptBinding	Element id AddressInformation.AddressType Short description AddressType Definition The type of address in question, such as a home address or mailing address. 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. Data type CodeableConcept Binding AddressType codes AddressType (required) Constraints 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
AddressUse		0..1	CodeableConceptBinding	Element id AddressInformation.AddressUse Short description AddressUse Definition The purpose of this address. 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. Data type CodeableConcept Binding AddressUse codes AddressUse (required) Constraints 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

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	CodeableConcept	0..1
AddressInformation.PlaceOfResidence	CodeableConcept	0..1
AddressInformation.Municipality	CodeableConcept	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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	string
Mappings	rim: n/a
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	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
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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	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
AddressInformation.Postcode
Definition	Postcode of the address.
Cardinality	0...1
Type	CodeableConcept
Binding	Postcode codes Postcode (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
AddressInformation.PlaceOfResidence
Definition	A geographically determined area which forms part of the municipal area.
Cardinality	0...1
Type	CodeableConcept
Binding	PlaceOfResidence codes PlaceOfResidence (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
AddressInformation.Municipality
Definition	Municipality of residence.
Cardinality	0...1
Type	CodeableConcept
Binding	Municipality codes Municipality (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
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	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
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	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
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	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
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	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

AddressInformation
Street	Knokstraat
HouseNumber	15
HouseNumberLetter
HouseNumberAddition
HouseNumberIndication
Postcode	8511
PlaceOfResidence	Aalbeke
Municipality	Kortrijk
Country	Belgium
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.
`Postcode`	type	Changed type from string to CodeableConcept to bind terminology in use within healthdata.be.
`PlaceOfResidence`	textual	Removed Dutch context.
`PlaceOfResidence`	type	Changed type from string to CodeableConcept to bind terminology in use within healthdata.be.
`Municipality`	textual	Removed Dutch context.
`Municipality`	type	Changed type from string to CodeableConcept to bind terminology in use within healthdata.be.
`Country`	terminology	Removed GBA country codes ValueSet so only ISO country codes and two nullflavor 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
Postcode	Postcode	required	https://fhir.healthdata.be/ValueSet/Postcode
PlaceOfResidence	PlaceOfResidence	required	https://fhir.healthdata.be/ValueSet/PlaceOfResidence
Municipality	Municipality	required	https://fhir.healthdata.be/ValueSet/Municipality
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