FHIR IG Statistics: StructureDefinition/HdBe-AddressInformation

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "HdBe-AddressInformation",
  "meta": {
    "lastUpdated": "2023-08-22T08:52:51.0668003+00:00"
  },
  "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation",
  "name": "HdBeAddressInformation",
  "title": "HdBe-AddressInformation",
  "status": "draft",
  "publisher": "Healthdata.be (Sciensano)",
  "contact": [
    {
      "name": "Service portal – healthdata.be",
      "telecom": [
        {
          "system": "url",
          "value": "https://sciensano.service-now.com/sp",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Address information includes data where a person resides (temporarily, permanently) or where a building is located.",
  "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.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "zib-addressinformation-v1.1-2020EN",
      "uri": "https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)",
      "name": "zib AddressInformation-v1.1(2020EN)"
    },
    {
      "identity": "HdBe-AddressInformation",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-AddressInformation",
      "name": "HdBe logical model AddressInformation"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "Address",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Address",
        "path": "Address",
        "short": "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 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.\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 element.\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 Belgian systems when dealing with Belgian addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\n**Mismatch in CBB and FHIR Datatypes**\r\nThe CBB AddressInformation model defines attributes such as PlaceOfResidence (`city`), Municipality (`district`), Postcode (`postalCode`), and Country (`country`) as CodeableConcepts, in order to bind them to the specific codes provided by the bpost system, as well as certain nullflavor codes. Conversely, the `Address` datatype represents these concepts using string data types.\r\n\r\nIn the context of international and Belgium standards, and considering that these specific codes can be accurately mapped to their corresponding string elements, the defining code system is deemed less relevant for addresses. Therefore, no effort has been made to align the datatypes by adding extensions or other modifications. This approach ensures alignment with international standards without compromising the integrity of the data, and avoids unnecessary complexity in the mapping process.",
        "alias": [
          "Adresgegevens"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.1",
            "comment": "AddressInformation"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation"
          }
        ]
      },
      {
        "id": "Address.extension",
        "path": "Address.extension",
        "min": 1
      },
      {
        "id": "Address.extension:language",
        "path": "Address.extension",
        "sliceName": "language",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/language"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Address.use",
        "path": "Address.use",
        "short": "AddressType",
        "definition": "The type of address in question, such as a home address or mailing address.",
        "alias": [
          "AdresSoort"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.8",
            "comment": "AddressType"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.AddressUse"
          }
        ]
      },
      {
        "id": "Address.type",
        "path": "Address.type",
        "short": "AddressType",
        "definition": "The type of address in question, such as a home address or mailing address.",
        "alias": [
          "AdresSoort"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.8",
            "comment": "AddressType"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.AddressType"
          }
        ]
      },
      {
        "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:streetName",
        "path": "Address.line.extension",
        "sliceName": "streetName",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
            ]
          }
        ]
      },
      {
        "id": "Address.line.extension:streetName.value[x]",
        "path": "Address.line.extension.value[x]",
        "short": "Street",
        "definition": "Street name of the address.",
        "alias": [
          "Straat"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.2",
            "comment": "Street"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.Street"
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumber",
        "path": "Address.line.extension",
        "sliceName": "houseNumber",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
            ]
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumber.value[x]",
        "path": "Address.line.extension.value[x]",
        "short": "HouseNumber",
        "definition": "House number of the address.",
        "alias": [
          "Huisnummer"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.12",
            "comment": "HouseNumber"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.HouseNumber"
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumberLetter-houseNumberAddition",
        "path": "Address.line.extension",
        "sliceName": "houseNumberLetter-houseNumberAddition",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
            ]
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumberLetter-houseNumberAddition.value[x]",
        "path": "Address.line.extension.value[x]",
        "short": "HouseNumberLetter / HouseNumberAddition",
        "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.",
        "alias": [
          "Huisnummerletter",
          "Huisnummertoevoeging"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.11",
            "comment": "HouseNumberLetter"
          },
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.10",
            "comment": "HouseNumberAddition"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.HouseNumberLetter"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.HouseNumberAddition"
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumberIndication",
        "path": "Address.line.extension",
        "sliceName": "houseNumberIndication",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
            ]
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumberIndication.value[x]",
        "path": "Address.line.extension.value[x]",
        "short": "HouseNumberIndication",
        "definition": "The indication used for addresses which do not consist of the usual street name and house number.",
        "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').",
        "alias": [
          "AanduidingBijNummer"
        ],
        "constraint": [
          {
            "key": "houseNumberIndication",
            "severity": "error",
            "human": "Must have value 'by' or 'to'",
            "expression": "$this in ('by' | 'to')"
          }
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.9",
            "comment": "HouseNumberIndication"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.HouseNumberIndication"
          }
        ]
      },
      {
        "id": "Address.line.extension:additionalInformation",
        "path": "Address.line.extension",
        "sliceName": "additionalInformation",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
            ]
          }
        ]
      },
      {
        "id": "Address.line.extension:additionalInformation.value[x]",
        "path": "Address.line.extension.value[x]",
        "short": "AdditionalInformation",
        "alias": [
          "AdditioneleInformatie"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.7",
            "comment": "AdditionalInformation"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.AdditionalInformation"
          }
        ]
      },
      {
        "id": "Address.city",
        "path": "Address.city",
        "short": "PlaceOfResidence",
        "definition": "A geographically determined area which forms part of the municipal area.",
        "alias": [
          "Woonplaats"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.3",
            "comment": "PlaceOfResidence"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.PlaceOfResidence"
          }
        ]
      },
      {
        "id": "Address.district",
        "path": "Address.district",
        "short": "Municipality",
        "definition": "Municipality of residence.",
        "alias": [
          "Gemeente"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.4",
            "comment": "Municipality"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.Municipality"
          }
        ]
      },
      {
        "id": "Address.postalCode",
        "path": "Address.postalCode",
        "short": "Postcode",
        "definition": "Postcode of the address.",
        "alias": [
          "Postcode"
        ],
        "mapping": [
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.6",
            "comment": "Postcode"
          },
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.Postcode"
          }
        ]
      },
      {
        "id": "Address.country",
        "path": "Address.country",
        "short": "Country",
        "definition": "Country in which the address is located.",
        "alias": [
          "Land"
        ],
        "binding": {
          "strength": "required",
          "description": "Iso 3166 Part 1: 2 Letter Codes",
          "valueSet": "https://fhir.healthdata.be/ValueSet/CountryISO"
        },
        "mapping": [
          {
            "identity": "HdBe-AddressInformation",
            "map": "AddressInformation.Country"
          },
          {
            "identity": "zib-addressinformation-v1.1-2020EN",
            "map": "NL-CM:20.5.5",
            "comment": "Country"
          }
        ]
      }
    ]
  }
}