{
  "description": "Name information includes a person's given names, nickname, last name and possibly the partner's last name.",
  "_filename": "HdBe-NameInformation.json",
  "package_name": "healthdata.be.r4.cbb",
  "date": null,
  "derivation": "constraint",
  "meta": {
    "lastUpdated": "2022-04-12T13:56:45.3303523+00:00"
  },
  "publisher": "Healthdata.be (Sciensano)",
  "fhirVersion": "4.0.1",
  "name": "HdBeNameInformation",
  "mapping": [ {
    "uri": "https://zibs.nl/wiki/NameInformation-v1.1(2020EN)",
    "name": "zib NameInformation-v1.1(2020EN)",
    "identity": "zib-nameinformation-v1.1-2020EN"
  }, {
    "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-NameInformation",
    "name": "HdBe logical model NameInformation",
    "identity": "HdBe-NameInformation"
  } ],
  "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": "HumanName",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "HdBe NameInformation",
  "package_version": "0.4.0-alpha",
  "status": "draft",
  "id": "d6c0d4d8-4c59-4df3-a733-6f0960a1ac0d",
  "kind": "complex-type",
  "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation",
  "version": null,
  "differential": {
    "element": [ {
      "constraint": [ {
        "key": "zib-NameInformation-1",
        "human": "If a prefix for a familiy name is specified, the family name is expected as well",
        "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation",
        "severity": "error",
        "expression": "name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()"
      }, {
        "key": "zib-NameInformation-2",
        "human": "If the prefix for a partner family name is specified, the partner family name is expected as well",
        "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation",
        "severity": "error",
        "expression": "name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()"
      }, {
        "key": "zib-NameInformation-3",
        "human": "If the name is specified as 'official' then the name is expected to contain only official parts",
        "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation",
        "severity": "warning",
        "expression": "use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()"
      } ],
      "path": "HumanName",
      "definition": "Name information includes a person's given names, nickname, last name and possibly the partner's last name.",
      "short": "NameInformation",
      "mapping": [ {
        "map": "NL-CM:20.4.1",
        "comment": "NameInformation",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "name_information",
        "identity": "HdBe-NameInformation"
      } ],
      "alias": [ "Naamgegevens" ],
      "id": "HumanName",
      "comment": "This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR _HumanName_, 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 _HumanName_ parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the `HumanName.text` element.\r\n\r\n**Separate name parts**\r\nThe extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel).  When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is.\r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas.\r\n\r\n* `family` = \"Jongeneel-de Haas\"\r\n* `given` = \"Irma\"\r\n* `family.extension:lastName` = \"Jongeneel\"\r\n* `family.extension:partnerPrefix` = \"de \"\r\n* `family.extension:partnerLastName` = \"Haas\"\r\n\r\n**The `HumanName.use` element**\r\n\r\nThe use of element `HumanName.use` is discouraged because the CBB model does not contain a corresponding concept. If `.use` is populated, its value SHALL match the semantics of the other elements. To illustrate: if `.use` is set to _official_, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name.\r\n\r\nIf the `.use` element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of `.use`. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance.\r\n\r\n**The CBB concept 'titles'**\r\n\r\nThe CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the `.prefix` and `.suffix` elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the `.prefix` element . Receiving systems should be resilient for a broader range of information in the `.prefix` element than stated by its definition. See the guidance on the `.prefix` and `.suffix` elements for more information.",
      "example": [ {
        "label": "Structured HumanName (preferred above unstructured)",
        "valueHumanName": {
          "text": "Irma Jongeneel-de Haas",
          "given": [ "Irma", "I." ],
          "_given": [ {
            "extension": [ {
              "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
              "valueCode": "CL"
            } ]
          }, {
            "extension": [ {
              "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
              "valueCode": "IN"
            } ]
          } ],
          "family": "Jongeneel-de Haas",
          "_family": {
            "extension": [ {
              "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
              "valueString": "Jongeneel"
            }, {
              "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
              "valueString": "de"
            }, {
              "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
              "valueString": "Haas"
            } ]
          },
          "extension": [ {
            "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
            "valueCode": "NL4"
          } ]
        }
      }, {
        "label": "Unstructured HumanName",
        "valueHumanName": {
          "text": "Irma Jongeneel-de Haas"
        }
      } ]
    }, {
      "id": "HumanName.extension",
      "min": 0,
      "path": "HumanName.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.extension:humannameAssemblyOrder",
      "min": 0,
      "path": "HumanName.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" ]
      } ],
      "sliceName": "humannameAssemblyOrder"
    }, {
      "id": "HumanName.extension:humannameAssemblyOrder.value[x]",
      "path": "HumanName.extension.value[x]",
      "alias": [ "Naamgebruik", "Voorkeursvolgorde van de naamdelen" ],
      "short": "NameUsage",
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1",
        "_valueSet": {
          "extension": [ {
            "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
            "valueCanonical": "https://fhir.healthdata.be/ConceptMap/NameUsage-to-HumanNameAssemblyOrder"
          } ]
        },
        "description": "Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder"
      },
      "mapping": [ {
        "map": "NL-CM:20.4.7",
        "comment": "NameUsage",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "name_usage",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "This concept indicates the last name or order of last names with which the person is to be addressed."
    }, {
      "id": "HumanName.use",
      "path": "HumanName.use",
      "comment": "This use of this element is discouraged because the CBB model does not contain a corresponding concept. If `use` is provided, it SHOULD align with the semantics of the other elements. To illustrate: if `use` is _official_ it is not expected that the concept 'GivenName' (NL: roepnaam) is present in the _HumanName_ container because this is not part of an official name."
    }, {
      "id": "HumanName.family.extension",
      "min": 0,
      "path": "HumanName.family.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.family.extension:prefix",
      "min": 0,
      "path": "HumanName.family.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" ]
      } ],
      "sliceName": "prefix"
    }, {
      "id": "HumanName.family.extension:prefix.value[x]",
      "path": "HumanName.family.extension.value[x]",
      "alias": [ "Voorvoegsels" ],
      "short": "Prefix",
      "mapping": [ {
        "map": "NL-CM:20.4.11",
        "comment": "Prefix",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "last_name.prefix",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "Prefix to the person’s own last name if not provided in LastName."
    }, {
      "id": "HumanName.family.extension:lastName",
      "min": 0,
      "path": "HumanName.family.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-own-name" ]
      } ],
      "sliceName": "lastName"
    }, {
      "id": "HumanName.family.extension:lastName.value[x]",
      "path": "HumanName.family.extension.value[x]",
      "alias": [ "Achternaam" ],
      "short": "LastName",
      "mapping": [ {
        "map": "NL-CM:20.4.10",
        "comment": "LastName",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "last_name.last_name",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "The person’s official last name.\r\n\r\nPreferrably, the last name prefix is captured using the `prefix` extension. It may however be included here for systems that do not record this separately."
    }, {
      "id": "HumanName.family.extension:partnerPrefix",
      "min": 0,
      "path": "HumanName.family.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" ]
      } ],
      "sliceName": "partnerPrefix"
    }, {
      "id": "HumanName.family.extension:partnerPrefix.value[x]",
      "path": "HumanName.family.extension.value[x]",
      "alias": [ "VoorvoegselsPartner" ],
      "short": "PartnerPrefix",
      "mapping": [ {
        "map": "NL-CM:20.4.9",
        "comment": "PartnerPrefix",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "last_name_partner.partner_prefix",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "Prefix to the partner’s last name if not provided in PartnerLastName."
    }, {
      "id": "HumanName.family.extension:partnerLastName",
      "min": 0,
      "path": "HumanName.family.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" ]
      } ],
      "sliceName": "partnerLastName"
    }, {
      "id": "HumanName.family.extension:partnerLastName.value[x]",
      "path": "HumanName.family.extension.value[x]",
      "alias": [ "AchternaamPartner" ],
      "short": "PartnerLastName",
      "mapping": [ {
        "map": "NL-CM:20.4.8",
        "comment": "PartnerLastName",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "last_name_partner.partner_last_name",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "Partner’s official last name.\r\n\r\nPreferrably, the partner' last name prefix is captured using the `partnerPrefix` extension. It may however be included here for systems that do not record this separately."
    }, {
      "id": "HumanName.given",
      "path": "HumanName.given",
      "comment": "To be conformant to the CBB for NameInformation, at least the following 'ISO 21090 EN Qualifiers' SHALL be supported: _BR_, _IN_ and _CL_. The qualifier _BR_ maps to the CBB concept FirstNames, _IN_ maps to Initials and _CL_ to GivenName.",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').value",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.given:firstNames",
      "max": "1",
      "path": "HumanName.given",
      "alias": [ "Voornamen" ],
      "short": "FirstNames",
      "mapping": [ {
        "map": "NL-CM:20.4.4",
        "comment": "FirstNames",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "first_names",
        "identity": "HdBe-NameInformation"
      } ],
      "sliceName": "firstNames",
      "definition": "The person’s official first names."
    }, {
      "id": "HumanName.given:firstNames.extension",
      "min": 1,
      "path": "HumanName.given.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.given:firstNames.extension:iso21090EnQualifier",
      "max": "1",
      "min": 1,
      "path": "HumanName.given.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" ]
      } ],
      "sliceName": "iso21090EnQualifier"
    }, {
      "id": "HumanName.given:firstNames.extension:iso21090EnQualifier.value[x]",
      "path": "HumanName.given.extension.value[x]",
      "patternCode": "BR"
    }, {
      "path": "HumanName.given",
      "definition": "The person’s initials.",
      "short": "Initials",
      "mapping": [ {
        "map": "NL-CM:20.4.5",
        "comment": "Initials",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "initials",
        "identity": "HdBe-NameInformation"
      } ],
      "sliceName": "initials",
      "alias": [ "Initialen" ],
      "max": "1",
      "id": "HumanName.given:initials",
      "comment": "Each initial is expected to be delimited by a dot."
    }, {
      "id": "HumanName.given:initials.extension",
      "min": 1,
      "path": "HumanName.given.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.given:initials.extension:iso21090EnQualifier",
      "max": "1",
      "min": 1,
      "path": "HumanName.given.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" ]
      } ],
      "sliceName": "iso21090EnQualifier"
    }, {
      "id": "HumanName.given:initials.extension:iso21090EnQualifier.value[x]",
      "path": "HumanName.given.extension.value[x]",
      "patternCode": "IN"
    }, {
      "id": "HumanName.given:givenName",
      "max": "1",
      "path": "HumanName.given",
      "alias": [ "Roepnaam" ],
      "short": "GivenName",
      "mapping": [ {
        "map": "NL-CM:20.4.6",
        "comment": "GivenName",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "given_name",
        "identity": "HdBe-NameInformation"
      } ],
      "sliceName": "givenName",
      "definition": "The name normally used to address the person."
    }, {
      "id": "HumanName.given:givenName.extension",
      "min": 1,
      "path": "HumanName.given.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "HumanName.given:givenName.extension:iso21090EnQualifier",
      "max": "1",
      "min": 1,
      "path": "HumanName.given.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" ]
      } ],
      "sliceName": "iso21090EnQualifier"
    }, {
      "id": "HumanName.given:givenName.extension:iso21090EnQualifier.value[x]",
      "path": "HumanName.given.extension.value[x]",
      "patternCode": "CL"
    }, {
      "id": "HumanName.prefix",
      "path": "HumanName.prefix",
      "alias": [ "Titels" ],
      "short": "Titles",
      "comment": "The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.\r\n\r\n**Export:**\r\n\r\nSystems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes.\r\n\r\nIf it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.\r\n\r\n**Import:**\r\n\r\nSystems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.",
      "mapping": [ {
        "map": "NL-CM:20.4.12",
        "comment": "Titles",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "titles",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "Noble and scientific titles. These can assist in formulating oral and formal addresing titles."
    }, {
      "id": "HumanName.suffix",
      "path": "HumanName.suffix",
      "alias": [ "Titels" ],
      "short": "Titles",
      "comment": "The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.\r\n\r\n**Export:**\r\n\r\nSystems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier _HON_ to indicate honorific prefixes and _AC_ for academic prefixes.\r\n\r\nIf it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.\r\n\r\n**Import:**\r\n\r\nSystems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.",
      "mapping": [ {
        "map": "NL-CM:20.4.12",
        "comment": "Titles",
        "identity": "zib-nameinformation-v1.1-2020EN"
      }, {
        "map": "titles",
        "identity": "HdBe-NameInformation"
      } ],
      "definition": "Noble and scientific titles. These can assist in formulating oral and formal addresing titles."
    } ]
  },
  "contact": [ {
    "name": "Service portal – healthdata.be",
    "telecom": [ {
      "use": "work",
      "value": "https://sciensano.service-now.com/sp",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName"
}