{
"description": "Address information includes data where a person resides (temporarily, permanently) or where a building is located.",
"_filename": "HdBe-AddressInformation.json",
"package_name": "healthdata.be.r4.cbb",
"date": null,
"derivation": "constraint",
"meta": {
"lastUpdated": "2022-02-16T17:06:25.0420171+00:00"
},
"publisher": "Healthdata.be (Sciensano)",
"fhirVersion": "4.0.1",
"name": "HdBeAddressInformation",
"mapping": [ {
"uri": "https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)",
"name": "zib AddressInformation-v1.1(2020EN)",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-AddressInformation",
"name": "HdBe logical model AddressInformation",
"identity": "HdBe-AddressInformation"
} ],
"abstract": false,
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"type": "Address",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "HdBe AddressInformation",
"package_version": "0.4.1-alpha",
"status": "draft",
"id": "b01f958a-d62a-4f53-bd24-63fdc6cc556a",
"kind": "complex-type",
"url": "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation",
"version": null,
"differential": {
"element": [ {
"id": "Address",
"path": "Address",
"alias": [ "Adresgegevens" ],
"short": "AddressInformation",
"mapping": [ {
"map": "NL-CM:20.5.1",
"comment": "AddressInformation",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "address_information",
"identity": "HdBe-AddressInformation"
} ],
"definition": "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 Belgium 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.\r\n\r\nTo 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 elements.\r\n\r\n**Separate address parts**\r\n\r\nThe first addition is that Belgium addresses make certain address parts separately communicable. These parts are required for use in true Belgium systems when dealing with Belgium addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\n**Custom address types**\r\n\r\nThe second addition is that the CBB defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the CBB concepts are mapped to the various FHIR elements (see the ConceptMaps and as well). The code from the CBB should also be included using the extension on `Address.extension:addressType`.\r\n\r\n | CBB | .ext:addressType | .use | .type |\r\n |-----------------------------------|------------------|------|----------|\r\n | Postal Address/Postadres | PST | | postal |\r\n | Primary Home/Officieel adres | HP | home | both |\r\n | Visit Address/Woon-/verblijfadres | PHYS | home | physical |\r\n | Temporary Address/Tijdelijk adres | TMP | temp | |\r\n | Work Place/Werkadres | WP | work | |\r\n | Vacation Home/Vakantie adres | HV | temp | |\r\n\r\nIf `Address.type` is _both_ then this is to be understood as a dual purpose address (postal and physical), unless a specific \"postal\" type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.\r\n\r\nNote: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the CBB's ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension."
}, {
"id": "Address.extension",
"min": 0,
"path": "Address.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Address.extension:addressType",
"max": "1",
"min": 0,
"path": "Address.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-AddressInformation.AddressType" ]
} ],
"sliceName": "addressType"
}, {
"id": "Address.extension:addressType.value[x]",
"path": "Address.extension.value[x]",
"mapping": [ {
"map": "NL-CM:20.5.8",
"comment": "AddressType",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "address_type",
"identity": "HdBe-AddressInformation"
} ]
}, {
"id": "Address.use",
"path": "Address.use",
"alias": [ "AdresSoort" ],
"short": "AddressType",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1",
"_valueSet": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
"valueCanonical": "https://fhir.healthdata.be/ConceptMap/AddressType-to-AddressUse"
} ]
},
"description": "Use ConceptMap 'AddressType-to-AddressUse' to translate CBB terminology to profile terminology in ValueSet 'AddressUse'"
},
"mapping": [ {
"map": "NL-CM:20.5.8",
"comment": "AddressType",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "address_type",
"identity": "HdBe-AddressInformation"
} ],
"definition": "The type of address in question, such as a home address or mailing address."
}, {
"id": "Address.type",
"path": "Address.type",
"alias": [ "AdresSoort" ],
"short": "AddressType",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1",
"_valueSet": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
"valueCanonical": "https://fhir.healthdata.be/ConceptMap/AddressType-to-AddressType"
} ]
},
"description": "Use ConceptMap 'AddressType-to-AddressType' to translate CBB terminology to profile terminology in ValueSet 'AddressType'"
},
"mapping": [ {
"map": "NL-CM:20.5.8",
"comment": "AddressType",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "address_type",
"identity": "HdBe-AddressInformation"
} ],
"definition": "The type of address in question, such as a home address or mailing address."
}, {
"id": "Address.line",
"path": "Address.line",
"comment": "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 `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: \"[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]\"."
}, {
"id": "Address.line.extension",
"min": 0,
"path": "Address.line.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Address.line.extension:streetName",
"max": "1",
"min": 0,
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" ]
} ],
"sliceName": "streetName"
}, {
"id": "Address.line.extension:streetName.value[x]",
"path": "Address.line.extension.value[x]",
"alias": [ "Straat" ],
"short": "Street",
"mapping": [ {
"map": "NL-CM:20.5.2",
"comment": "Street",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "street",
"identity": "HdBe-AddressInformation"
} ],
"definition": "Street name of the address."
}, {
"id": "Address.line.extension:houseNumber",
"max": "1",
"min": 0,
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" ]
} ],
"sliceName": "houseNumber"
}, {
"id": "Address.line.extension:houseNumber.value[x]",
"path": "Address.line.extension.value[x]",
"alias": [ "Huisnummer" ],
"short": "HouseNumber",
"mapping": [ {
"map": "NL-CM:20.5.12",
"comment": "HouseNumber",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "house_number",
"identity": "HdBe-AddressInformation"
} ],
"definition": "House number of the address."
}, {
"id": "Address.line.extension:houseNumberLetter-houseNumberAddition",
"max": "1",
"min": 0,
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" ]
} ],
"sliceName": "houseNumberLetter-houseNumberAddition"
}, {
"id": "Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]",
"path": "Address.line.extension.value[x]",
"alias": [ "Huisnummerletter", "Huisnummertoevoeging" ],
"short": "HouseNumberLetter / HouseNumberAddition",
"mapping": [ {
"map": "NL-CM:20.5.11",
"comment": "HouseNumberLetter",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "NL-CM:20.5.10",
"comment": "HouseNumberAddition",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "house_number_letter",
"identity": "HdBe-AddressInformation"
}, {
"map": "house_number_addition",
"identity": "HdBe-AddressInformation"
} ],
"definition": "Export:\r\n\r\n- If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition.\r\n- If only a HouseNumberLetter is known, send just that. No trailing space is required.\r\n- If only a HouseNumberAddition is known, communicate that with a leading space.\r\n\r\nImport\r\n\r\n- If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter.\r\n- If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition.\r\n\r\nNote: 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."
}, {
"id": "Address.line.extension:houseNumberIndication",
"max": "1",
"min": 0,
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" ]
} ],
"sliceName": "houseNumberIndication"
}, {
"id": "Address.line.extension:houseNumberIndication.value[x]",
"path": "Address.line.extension.value[x]",
"alias": [ "AanduidingBijNummer" ],
"short": "HouseNumberIndication",
"comment": "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').",
"mapping": [ {
"map": "NL-CM:20.5.9",
"comment": "HouseNumberIndication",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "house_number_indication",
"identity": "HdBe-AddressInformation"
} ],
"constraint": [ {
"key": "houseNumberIndication",
"human": "Must have value 'by' or 'to'",
"source": "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation",
"severity": "error",
"expression": "value in ('by' | 'to')"
} ],
"definition": "The indication used for addresses which do not consist of the usual street name and house number."
}, {
"id": "Address.line.extension:additionalInformation",
"max": "1",
"min": 0,
"path": "Address.line.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" ]
} ],
"sliceName": "additionalInformation"
}, {
"id": "Address.line.extension:additionalInformation.value[x]",
"path": "Address.line.extension.value[x]",
"alias": [ "AdditioneleInformatie" ],
"short": "AdditionalInformation",
"mapping": [ {
"map": "NL-CM:20.5.7",
"comment": "AdditionalInformation",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "additional_information",
"identity": "HdBe-AddressInformation"
} ]
}, {
"id": "Address.city",
"path": "Address.city",
"alias": [ "Woonplaats" ],
"short": "PlaceOfResidence",
"mapping": [ {
"map": "NL-CM:20.5.3",
"comment": "PlaceOfResidence",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "place_of_residence",
"identity": "HdBe-AddressInformation"
} ],
"definition": "A geographically determined area which forms part of the municipal area."
}, {
"id": "Address.district",
"path": "Address.district",
"alias": [ "Gemeente" ],
"short": "Municipality",
"mapping": [ {
"map": "NL-CM:20.5.4",
"comment": "Municipality",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "municipality",
"identity": "HdBe-AddressInformation"
} ],
"definition": "Municipality of residence."
}, {
"id": "Address.postalCode",
"path": "Address.postalCode",
"alias": [ "Postcode" ],
"short": "Postcode",
"mapping": [ {
"map": "NL-CM:20.5.6",
"comment": "Postcode",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "postcode",
"identity": "HdBe-AddressInformation"
} ],
"definition": "Postcode of the address."
}, {
"id": "Address.country",
"path": "Address.country",
"comment": "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 `Address.country.extension:countryCode`."
}, {
"id": "Address.country.extension",
"min": 0,
"path": "Address.country.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Address.country.extension:countryCode",
"max": "1",
"min": 0,
"path": "Address.country.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification" ]
} ],
"sliceName": "countryCode"
}, {
"id": "Address.country.extension:countryCode.value[x]",
"path": "Address.country.extension.value[x]",
"alias": [ "Land" ],
"short": "Country",
"binding": {
"strength": "required",
"valueSet": "https://fhir.healthdata.be/ValueSet/CountryISO",
"description": "Iso 3166 Part 1: 2 Letter Codes"
},
"mapping": [ {
"map": "NL-CM:20.5.5",
"comment": "Country",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "country",
"identity": "HdBe-AddressInformation"
} ],
"definition": "Country in which the address is located."
} ]
},
"contact": [ {
"name": "Service portal – healthdata.be",
"telecom": [ {
"use": "work",
"value": "https://sciensano.service-now.com/sp",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address"
}