HdBe-AddressInformation
Profile | Description | Status | URL |
---|---|---|---|
HdBe-AddressInformation | Address information includes data where a person resides (temporarily, permanently) or where a building is located. | draft | https://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. |
Address | Address | Element IdAddress AddressInformation Alternate namesAdresgegevens DefinitionThis 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. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| ||
extension | I | 1..* | Extension | Element IdAddress.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
language | I | 1..1 | Extension(code) | Element IdAddress.extension:language Human Language for the item Alternate namesextensions, user content DefinitionThe Human Language of the item. This is used where an item may repeat to indicate the language of each repeat. http://hl7.org/fhir/StructureDefinition/language Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element IdAddress.use AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | Σ | 0..1 | codeBinding | Element IdAddress.type AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string | Element IdAddress.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the
General 137 Nowhere Street Mappings
|
extension | I | 0..* | Extension | Element IdAddress.line.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
streetName | I | 0..1 | Extension(string) | Element IdAddress.line.extension:streetName streetName Alternate namesextensions, user content DefinitionstreetName. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| |
value[x] | 1..1 | Element IdAddress.line.extension:streetName.value[x] Street Alternate namesStraat DefinitionStreet name of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumber | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumber.value[x] HouseNumber Alternate namesHuisnummer DefinitionHouse number of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberLetter-houseNumberAddition | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition buildingNumberSuffix Alternate namesextensions, user content DefinitionAny alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.value[x] HouseNumberLetter / HouseNumberAddition Alternate namesHuisnummerletter, Huisnummertoevoeging DefinitionExport:
Import
Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberIndication | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberIndication additionalLocator Alternate namesextensions, user content DefinitionThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberIndication.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
| |
value[x] | I | 1..1 | Element IdAddress.line.extension:houseNumberIndication.value[x] HouseNumberIndication Alternate namesAanduidingBijNummer DefinitionThe indication used for addresses which do not consist of the usual street name and house number. The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
| |
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalInformation | I | 0..1 | Extension(string) | Element IdAddress.line.extension:additionalInformation unitID Alternate namesextensions, user content DefinitionThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:additionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
| |
value[x] | 1..1 | Element IdAddress.line.extension:additionalInformation.value[x] AdditionalInformation Alternate namesAdditioneleInformatie DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
city | Σ | 0..1 | string | Element IdAddress.city PlaceOfResidence Alternate namesMunicpality, Woonplaats DefinitionA geographically determined area which forms part of the municipal area. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | Element IdAddress.district Municipality Alternate namesCounty, Gemeente DefinitionMunicipality of residence. District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
state | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | Σ | 0..1 | string | Element IdAddress.postalCode Postcode Alternate namesZip, Postcode DefinitionPostcode of the address. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | Σ | 0..1 | string | Element IdAddress.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under
|
extension | I | 0..* | Extension | Element IdAddress.country.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
countryCode | I | 0..1 | Extension(CodeableConcept) | Element IdAddress.country.extension:countryCode Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
value[x] | 0..1 | Binding | Element IdAddress.country.extension:countryCode.value[x] Country Alternate namesLand DefinitionCountry in which the address is located. Iso 3166 Part 1: 2 Letter Codes CountryISO (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAddress.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
Address | Address | Element IdAddress AddressInformation Alternate namesAdresgegevens DefinitionThis 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. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| ||
extension | I | 1..* | Extension | Element IdAddress.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
language | I | 1..1 | Extension(code) | Element IdAddress.extension:language Human Language for the item Alternate namesextensions, user content DefinitionThe Human Language of the item. This is used where an item may repeat to indicate the language of each repeat. http://hl7.org/fhir/StructureDefinition/language Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element IdAddress.use AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | Σ | 0..1 | codeBinding | Element IdAddress.type AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string | Element IdAddress.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the
General 137 Nowhere Street Mappings
|
extension | I | 0..* | Extension | Element IdAddress.line.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
streetName | I | 0..1 | Extension(string) | Element IdAddress.line.extension:streetName streetName Alternate namesextensions, user content DefinitionstreetName. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| |
value[x] | 1..1 | Element IdAddress.line.extension:streetName.value[x] Street Alternate namesStraat DefinitionStreet name of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumber | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumber.value[x] HouseNumber Alternate namesHuisnummer DefinitionHouse number of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberLetter-houseNumberAddition | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition buildingNumberSuffix Alternate namesextensions, user content DefinitionAny alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.value[x] HouseNumberLetter / HouseNumberAddition Alternate namesHuisnummerletter, Huisnummertoevoeging DefinitionExport:
Import
Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberIndication | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberIndication additionalLocator Alternate namesextensions, user content DefinitionThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberIndication.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
| |
value[x] | I | 1..1 | Element IdAddress.line.extension:houseNumberIndication.value[x] HouseNumberIndication Alternate namesAanduidingBijNummer DefinitionThe indication used for addresses which do not consist of the usual street name and house number. The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
| |
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalInformation | I | 0..1 | Extension(string) | Element IdAddress.line.extension:additionalInformation unitID Alternate namesextensions, user content DefinitionThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:additionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
| |
value[x] | 1..1 | Element IdAddress.line.extension:additionalInformation.value[x] AdditionalInformation Alternate namesAdditioneleInformatie DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
city | Σ | 0..1 | string | Element IdAddress.city PlaceOfResidence Alternate namesMunicpality, Woonplaats DefinitionA geographically determined area which forms part of the municipal area. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | Element IdAddress.district Municipality Alternate namesCounty, Gemeente DefinitionMunicipality of residence. District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
state | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | Σ | 0..1 | string | Element IdAddress.postalCode Postcode Alternate namesZip, Postcode DefinitionPostcode of the address. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | Σ | 0..1 | string | Element IdAddress.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under
|
extension | I | 0..* | Extension | Element IdAddress.country.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
countryCode | I | 0..1 | Extension(CodeableConcept) | Element IdAddress.country.extension:countryCode Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
value[x] | 0..1 | Binding | Element IdAddress.country.extension:countryCode.value[x] Country Alternate namesLand DefinitionCountry in which the address is located. Iso 3166 Part 1: 2 Letter Codes CountryISO (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAddress.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
Address | Address | Element IdAddress AddressInformation Alternate namesAdresgegevens DefinitionThis 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. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| ||
extension | I | 1..* | Extension | Element IdAddress.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
language | I | 1..1 | Extension(code) | Element IdAddress.extension:language Human Language for the item Alternate namesextensions, user content DefinitionThe Human Language of the item. This is used where an item may repeat to indicate the language of each repeat. http://hl7.org/fhir/StructureDefinition/language Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element IdAddress.use AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | Σ | 0..1 | codeBinding | Element IdAddress.type AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string | Element IdAddress.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the
General 137 Nowhere Street Mappings
|
extension | I | 0..* | Extension | Element IdAddress.line.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
streetName | I | 0..1 | Extension(string) | Element IdAddress.line.extension:streetName streetName Alternate namesextensions, user content DefinitionstreetName. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| |
value[x] | 1..1 | Element IdAddress.line.extension:streetName.value[x] Street Alternate namesStraat DefinitionStreet name of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumber | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumber.value[x] HouseNumber Alternate namesHuisnummer DefinitionHouse number of the address.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberLetter-houseNumberAddition | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition buildingNumberSuffix Alternate namesextensions, user content DefinitionAny alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
| |
value[x] | 1..1 | Element IdAddress.line.extension:houseNumberLetter-houseNumberAddition.value[x] HouseNumberLetter / HouseNumberAddition Alternate namesHuisnummerletter, Huisnummertoevoeging DefinitionExport:
Import
Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
houseNumberIndication | I | 0..1 | Extension(string) | Element IdAddress.line.extension:houseNumberIndication additionalLocator Alternate namesextensions, user content DefinitionThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:houseNumberIndication.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
| |
value[x] | I | 1..1 | Element IdAddress.line.extension:houseNumberIndication.value[x] HouseNumberIndication Alternate namesAanduidingBijNummer DefinitionThe indication used for addresses which do not consist of the usual street name and house number. The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
| |
valueString | string | There are no (further) constraints on this element Data Type | ||
additionalInformation | I | 0..1 | Extension(string) | Element IdAddress.line.extension:additionalInformation unitID Alternate namesextensions, user content DefinitionThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.line.extension:additionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
| |
value[x] | 1..1 | Element IdAddress.line.extension:additionalInformation.value[x] AdditionalInformation Alternate namesAdditioneleInformatie DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
city | Σ | 0..1 | string | Element IdAddress.city PlaceOfResidence Alternate namesMunicpality, Woonplaats DefinitionA geographically determined area which forms part of the municipal area. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | Element IdAddress.district Municipality Alternate namesCounty, Gemeente DefinitionMunicipality of residence. District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
state | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAddress.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | Σ | 0..1 | string | Element IdAddress.postalCode Postcode Alternate namesZip, Postcode DefinitionPostcode of the address. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | Σ | 0..1 | string | Element IdAddress.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under
|
extension | I | 0..* | Extension | Element IdAddress.country.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
countryCode | I | 0..1 | Extension(CodeableConcept) | Element IdAddress.country.extension:countryCode Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdAddress.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification
| |
value[x] | 0..1 | Binding | Element IdAddress.country.extension:countryCode.value[x] Country Alternate namesLand DefinitionCountry in which the address is located. Iso 3166 Part 1: 2 Letter Codes CountryISO (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAddress.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Address | AddressInformation | HdBe-AddressInformation |
Address.use | AddressInformation.AddressUse | HdBe-AddressInformation |
Address.type | AddressInformation.AddressType | HdBe-AddressInformation |
Address.line.extension:streetName.value[x] | AddressInformation.Street | HdBe-AddressInformation |
Address.line.extension:houseNumber.value[x] | AddressInformation.HouseNumber | HdBe-AddressInformation |
Address.line.extension:houseNumberLetter-houseNumberAddition.value[x] | AddressInformation.HouseNumberLetter | HdBe-AddressInformation |
Address.line.extension:houseNumberLetter-houseNumberAddition.value[x] | AddressInformation.HouseNumberAddition | HdBe-AddressInformation |
Address.line.extension:houseNumberIndication.value[x] | AddressInformation.HouseNumberIndication | HdBe-AddressInformation |
Address.line.extension:additionalInformation.value[x] | AddressInformation.AdditionalInformation | HdBe-AddressInformation |
Address.city | AddressInformation.PlaceOfResidence | HdBe-AddressInformation |
Address.district | AddressInformation.Municipality | HdBe-AddressInformation |
Address.postalCode | AddressInformation.Postcode | HdBe-AddressInformation |
Address.country.extension:countryCode.value[x] | AddressInformation.Country | HdBe-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. |
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.extension:countryCode.value[x] |
terminology | Replaced valueSet LandCodelijsten with CountryISO. |
extension:addressType |
element | Removed the extension, as the terminology of the CBB was simplified, which makes the extension unnecessary. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
Address.country.extension.value[x] | CountryISO | required | https://fhir.healthdata.be/ValueSet/CountryISO | No bound ConceptMap |