FHIR IG Statistics: StructureDefinition/nl-core-address

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "nl-core-address",
  "meta": {
    "versionId": "6",
    "lastUpdated": "2018-02-20T15:35:28.601+01:00"
  },
  "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address",
  "version": "1.1",
  "name": "nl-core-address",
  "title": "nl-core-address",
  "status": "retired",
  "publisher": "HL7 Netherlands",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "email",
          "value": "info@nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Address Type with additions for Dutch realm addresses. Dutch addresses break down Address.line in several parts and it is important to mark an address as being 'officially registered'. In version 1.1 the missing mappings for AddressType have been added for 2015 and all mappings for HCIMs release 2017.",
  "purpose": "Address information is used for visiting a person or organization and for addressing of mail.",
  "copyright": "CC0",
  "fhirVersion": "3.0.1",
  "mapping": [
    {
      "identity": "hcim-address-v2.0.1-2015EN",
      "uri": "https://zibs.nl/wiki/Patient-v2.0.1(2015EN)",
      "name": "AddressInformation as part of HCIM Patient-v2.0.1(2015EN)",
      "comment": "AddressInformation has become an independent information model as of release 2017 of the HCIMs"
    },
    {
      "identity": "hcim-addressinformation-v3.0-2016EN",
      "uri": "https://zibs.nl/wiki/Patient-v3.0(2016EN)",
      "name": "AddressInformation as part of HCIM Patient-v3.0(2016EN)",
      "comment": "AddressInformation has become an independent information model as of release 2017 of the HCIMs"
    },
    {
      "identity": "hcim-addressinformation-v1.0-2017EN",
      "uri": "https://zibs.nl/wiki/AddressInformation-v1.0(2017EN)",
      "name": "HCIM AddressInformation-v1.0.1(2017EN)"
    },
    {
      "identity": "BRP",
      "uri": "https://nl.wikipedia.org/wiki/Basisregistratie_Personen",
      "name": "Basisregistratie Personen",
      "comment": "Voorheen GBA - Gemeentelijke basisregistratie"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "Address",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Address",
        "path": "Address",
        "short": "Address information",
        "definition": "There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses. \r\n\r\nA Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\nTo have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\nThe HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that.\r\n\r\nHCIM Postal Address maps to Address.type 'postal'; \r\n\r\nHCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP'; \r\n\r\nHCIM Visit Address maps to Address.use 'temp' + Address.type 'physical' + Address.use.extension 'PHYS'; \r\n\r\nHCIM Temporary Address maps to Address.use 'temp'; \r\n\r\nHCIM Work Place Address maps to Address.use 'work';  \r\n\r\nHCIM Vacation Home Address maps to Address.type 'temp' + Address.use.extension 'HV'.",
        "alias": [
          "AdresInformatie"
        ],
        "example": [
          {
            "label": "Example of a vacation home address",
            "valueAddress": {
              "extension": [
                {
                  "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
                  "valueBoolean": false
                }
              ],
              "use": "temp",
              "_use": {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use",
                    "valueCode": "HV"
                  }
                ]
              },
              "line": [
                "Binnenkant 12A Hoog"
              ],
              "_line": [
                {
                  "extension": [
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
                      "valueString": "Binnenkant"
                    },
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
                      "valueString": "12"
                    },
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
                      "valueString": "A"
                    },
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID",
                      "valueString": "Hoog"
                    }
                  ]
                }
              ],
              "city": "Amsterdam",
              "state": "NH",
              "postalCode": "1000AA",
              "country": "NLD"
            }
          },
          {
            "label": "Example of a primary home address",
            "valueAddress": {
              "extension": [
                {
                  "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
                  "valueBoolean": true
                }
              ],
              "use": "home",
              "line": [
                "Binnenkant to 10"
              ],
              "_line": [
                {
                  "extension": [
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
                      "valueString": "Binnenkant"
                    },
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
                      "valueString": "to"
                    },
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
                      "valueString": "10"
                    }
                  ]
                }
              ],
              "city": "Amsterdam",
              "state": "NH",
              "postalCode": "1001AA",
              "country": "NLD"
            }
          }
        ],
        "condition": [
          "nl-streetname-if-official-and-other-line-parts"
        ],
        "constraint": [
          {
            "key": "nl-streetname-if-official-and-other-line-parts",
            "requirements": "This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address",
            "severity": "error",
            "human": "Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value",
            "expression": "(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))",
            "xpath": "not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.4"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.4"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.1"
          }
        ]
      },
      {
        "id": "Address.extension",
        "path": "Address.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Address.extension:official",
        "path": "Address.extension",
        "sliceName": "official",
        "short": "Mark an address as an 'officially registered' address.",
        "definition": "Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP)",
        "alias": [
          "Markeer een adres als een 'officieel geregistreerd adres."
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.11"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.11"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.8"
          }
        ]
      },
      {
        "id": "Address.use",
        "path": "Address.use",
        "definition": "Purpose of this address",
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.11"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.8"
          }
        ]
      },
      {
        "id": "Address.use.extension",
        "path": "Address.use.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Address.use.extension:AD_use",
        "path": "Address.use.extension",
        "sliceName": "AD_use",
        "short": "Further define the address use with the exact HCIM code.",
        "definition": "Further define the address use with the exact HCIM code. Mostly relevant to distinguish between different types of temporasry addresses.",
        "alias": [
          "Precieze definiëring van adressoort op basis van exacte zib-code"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"
          }
        ]
      },
      {
        "id": "Address.type",
        "path": "Address.type",
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.11"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.8"
          }
        ]
      },
      {
        "id": "Address.line",
        "path": "Address.line"
      },
      {
        "id": "Address.line.extension",
        "path": "Address.line.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Address.line.extension:streetName",
        "path": "Address.line.extension",
        "sliceName": "streetName",
        "requirements": "Basisregistratie Persoonsgegevens 11.10 Straatnaam",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.12"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.12"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.2"
          },
          {
            "identity": "BRP",
            "map": "11.10 Straatnaam"
          }
        ]
      },
      {
        "id": "Address.line.extension:streetName.url",
        "path": "Address.line.extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
      },
      {
        "id": "Address.line.extension:houseNumber",
        "path": "Address.line.extension",
        "sliceName": "houseNumber",
        "requirements": "Basisregistratie Persoonsgegevens 11.20 Huisnummer",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.13"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.13"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.12"
          },
          {
            "identity": "BRP",
            "map": "11.20 Huisnummer"
          }
        ]
      },
      {
        "id": "Address.line.extension:houseNumber.url",
        "path": "Address.line.extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
      },
      {
        "id": "Address.line.extension:buildingNumbersuffix",
        "path": "Address.line.extension",
        "sliceName": "buildingNumbersuffix",
        "definition": "HouseNumberLetter - A letter following the house number as assigned by the municipal authorities.\r\nHouseNumberAddition - The letters or signs needed to locate the mailbox, in addition to the house number and letter.",
        "requirements": "Basisregistratie Persoonsgegevens 11.30 Huisletter\r\n11.40 Huisnummertoevoeging\r\n12.10 Locatieomschrijving",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.40"
          },
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.41"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.40"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.41"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.11"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.10"
          },
          {
            "identity": "BRP",
            "map": "11.30 Huisletter"
          },
          {
            "identity": "BRP",
            "map": "11.40 Huisnummertoevoeging"
          }
        ]
      },
      {
        "id": "Address.line.extension:buildingNumbersuffix.url",
        "path": "Address.line.extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
      },
      {
        "id": "Address.line.extension:unitID",
        "path": "Address.line.extension",
        "sliceName": "unitID",
        "definition": "Extra information such as the building name, building number, entrance, route number.",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.28"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.28"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.7"
          }
        ]
      },
      {
        "id": "Address.line.extension:unitID.url",
        "path": "Address.line.extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
      },
      {
        "id": "Address.line.extension:additionalLocator",
        "path": "Address.line.extension",
        "sliceName": "additionalLocator",
        "definition": "HouseNumberIndication - The indication used for addresses which do not consist of the usual street name and house number.",
        "requirements": "Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.42"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.42"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.9"
          },
          {
            "identity": "BRP",
            "map": "11.50 Aanduiding bij huisnummer"
          }
        ]
      },
      {
        "id": "Address.line.extension:additionalLocator.url",
        "path": "Address.line.extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
      },
      {
        "id": "Address.city",
        "path": "Address.city",
        "requirements": "Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam",
        "alias": [
          "Municipality",
          "woonplaats"
        ],
        "example": [
          {
            "label": "Example city",
            "valueString": "Den Haag"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.14"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.14"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.3"
          },
          {
            "identity": "BRP",
            "map": "11.70 Woonplaatsnaam"
          }
        ]
      },
      {
        "id": "Address.district",
        "path": "Address.district",
        "comment": "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. In a Dutch address this element is used for the population of a \"gemeente\"",
        "requirements": "Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving",
        "alias": [
          "Gemeente"
        ],
        "example": [
          {
            "label": "Example district",
            "valueString": "Wateringen"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.16"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.16"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.4"
          },
          {
            "identity": "BRP",
            "map": "09.10 Gemeente van inschrijving"
          }
        ]
      },
      {
        "id": "Address.state",
        "path": "Address.state",
        "short": "Sub-unit of country (abbreviations ok).",
        "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). For Dutch addresses this element should contain the \"provincie\" code",
        "requirements": "Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and  Geesteren (Gelderland / Overijssel).",
        "alias": [
          "Provincie"
        ],
        "example": [
          {
            "label": "Example province",
            "valueString": "ZH"
          }
        ]
      },
      {
        "id": "Address.postalCode",
        "path": "Address.postalCode",
        "comment": "Dutch postal codes have pattern '\\d{4}[A-Z]{2}' so they do not have spaces. Systems can easily render postal codes with a space if necessary.",
        "alias": [
          "Postcode"
        ],
        "example": [
          {
            "label": "Example postcode",
            "valueString": "9132AG"
          }
        ],
        "condition": [
          "nl-postal-code-pattern"
        ],
        "constraint": [
          {
            "key": "nl-postal-code-pattern",
            "severity": "error",
            "human": "Dutch postal code pattern 'nnnnAA'",
            "expression": "(country in 'nl' | 'nld' | 'nederland').not() or matches('^\\\\d{4}[A-Z]{2}[%content%]#39;)",
            "xpath": "not(../f:country[lower-case(@value)=('nl','nld','nederland')]) or matches(@value,'^\\d{4}[A-Z]{2}[%content%]#39;)"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.15"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.15"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.6"
          },
          {
            "identity": "BRP",
            "map": "11.60 Postcode"
          }
        ]
      },
      {
        "id": "Address.country",
        "path": "Address.country",
        "short": "Country (can be ISO 3166 3 letter code)",
        "definition": "A country (code) for the address.",
        "alias": [
          "land"
        ],
        "example": [
          {
            "label": "Example country",
            "valueString": "NLD"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-address-v2.0.1-2015EN",
            "map": "NL-CM:0.1.17"
          },
          {
            "identity": "hcim-addressinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.17"
          },
          {
            "identity": "hcim-addressinformation-v1.0-2017EN",
            "map": "NL-CM:20.5.5"
          }
        ]
      }
    ]
  }
}