{
"description": "Base datatype for HumanName Type with additions for Dutch realm names. Dutch names break down the family into maximum of 4 parts that are important to know separately in some if not most use cases.",
"_filename": "nl-core-humanname.json",
"package_name": "nictiz.fhir.nl.stu3.zib2017",
"date": null,
"derivation": "constraint",
"publisher": "HL7 Netherlands",
"fhirVersion": "3.0.2",
"purpose": "Name information is used to identify and address person.",
"name": "nl-core-humanname",
"mapping": [ {
"uri": "https://zibs.nl/wiki/Patient-v2.0.1(2015EN)",
"name": "NameInformation as part of HCIM Patient-v2.0.1(2015EN)",
"comment": "NameInformation has become an independent information model as of release 2017 of the HCIMs",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"uri": "https://zibs.nl/wiki/Patient-v3.0(2016EN)",
"name": "NameInformation as part of HCIM Patient-v3.0(2016EN)",
"comment": "NameInformation has become an independent information model as of release 2017 of the HCIMs",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/NameInformation-v1.0.1(2017EN)",
"name": "HCIM NameInformation-v1.0.1(2017EN)",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"uri": "https://nl.wikipedia.org/wiki/Basisregistratie_Personen",
"name": "Basisregistratie Personen",
"comment": "Voorheen GBA - Gemeentelijke basisregistratie",
"identity": "BRP"
} ],
"abstract": false,
"copyright": "CC0",
"type": "HumanName",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "nl-core-humanname",
"package_version": "2.2.11",
"status": "active",
"id": "056293cf-a1a2-4fae-ae4e-4e776bab7bb4",
"kind": "complex-type",
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname",
"version": "2.0.9",
"differential": {
"element": [ {
"id": "HumanName",
"path": "HumanName",
"comment": "Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information.\r\n\r\nThe extension elements cover birth name (NL: eigennaam / geslachtsnaam) 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.\r\n\r\n**Incompatibility note**: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. \r\n\r\nThe issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the `.use` element. However, this specification allows for including all alternative representations in the _same_ HumanName instance, with the expectation that the extensions provide enough information for receiving systems to differentiate them. However, this means that contrary to the normal usage of this datatype, repetitions of `.given` names cannot be concatenated to get the full list of given names; the list might be a mix of full names, nicknames and initials.\r\n\r\nSince multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically:\r\n\r\n* Sending and receiving systems SHOULD always use the specified extensions when using this datatype.\r\n* Sending systems are encouraged to populate the `.text` element to unambigiously communicate the person's name.\r\n* Sending systems are encouraged to send either the full given names or the initials, but not both. This alleviates the duplication of names in `.given`.\r\n* When a sending system uses the current one-instance approach for communicating multiple representations, `.use` MAY NOT be populated. After all, it is not possible to select a single `.use` when the instance contains different representations.\r\n* When a receiving system interprets the instance as the single-instance-multiple-representations approach, the `.given` names marked as initials SHOULD be interpreted as alternatives to the full given names. Note the underlying HCIM expects both the _list_ of full names and _list_ of initials to be a single string; there's no match for an initial to a full name. The instance SHOULD be regarded as using this approach when:\r\n * They encounter a single instance\r\n * And the `.use` element is absent\r\n * And all the name parts are differentiated using the specified extensions\r\n* In any other circumstance, receiving systems SHOULD interpret the usage as the normal use.\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\" (with `.given:iso21090EnQualifier` = _BR_)\r\n* `.family:humannameOwnName` = \"Jongeneel\"\r\n* `.family:humannamePartnerPrefix` = \"de \"\r\n* `.family:humannamePartnerName` = \"Haas\"",
"example": [ {
"label": "Structured HumanName (preferred above unstructured)",
"valueHumanName": {
"text": "Irma Jongeneel-de Haas",
"given": [ "Irma" ],
"_given": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
} ]
} ],
"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"
}
} ],
"mapping": [ {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.1",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "02",
"comment": "Naam",
"identity": "BRP"
} ],
"constraint": [ {
"key": "nl-core-humanname-1",
"human": "if you specify a prefix for an own name then an own name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']",
"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": "nl-core-humanname-2",
"human": "if you specify a voorvoegsel for a partner name then a partner name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']",
"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()"
} ]
}, {
"id": "HumanName.extension",
"path": "HumanName.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HumanName.extension:humannameAssemblyOrder",
"path": "HumanName.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
} ],
"alias": [ "Voorkeursvolgorde van de naamdelen." ],
"binding": {
"strength": "required",
"description": "Human Name Assembly Order",
"valueSetReference": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
"valueReference": {
"display": "NaamgebruikCodelijst-to-HumanNameAssemblyOrder",
"reference": "http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder"
}
} ],
"reference": "http://hl7.org/fhir/ValueSet/name-assembly-order"
}
},
"mapping": [ {
"map": "NL-CM:0.1.34",
"comment": "NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.34",
"comment": "NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.7",
"comment": "NameUsage. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"sliceName": "humannameAssemblyOrder"
}, {
"id": "HumanName.extension:humannameAssemblyOrder.valueCode:valueCode",
"path": "HumanName.extension.valueCode",
"sliceName": "valueCode"
}, {
"id": "HumanName.text",
"path": "HumanName.text",
"mapping": [ {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.1-2017EN"
} ]
}, {
"id": "HumanName.family",
"path": "HumanName.family",
"alias": [ "Achternaam" ],
"short": "Surname"
}, {
"id": "HumanName.family.extension",
"path": "HumanName.family.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HumanName.family.extension:humannameOwnPrefix",
"path": "HumanName.family.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
} ],
"alias": [ "VoorvoegselGeslachtsnaam" ],
"short": "PrefixOwnName",
"mapping": [ {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.11",
"comment": "Prefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"sliceName": "humannameOwnPrefix",
"definition": "The prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse."
}, {
"id": "HumanName.family.extension:humannameOwnPrefix.valueString:valueString",
"path": "HumanName.family.extension.valueString",
"sliceName": "valueString"
}, {
"path": "HumanName.family.extension",
"definition": "The person’s official last name.",
"short": "OwnName",
"mapping": [ {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.10",
"comment": "LastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
} ],
"sliceName": "humannameOwnName",
"alias": [ "Geslachtsnaam" ],
"id": "HumanName.family.extension:humannameOwnName",
"comment": "The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\"."
}, {
"id": "HumanName.family.extension:humannameOwnName.valueString:valueString",
"path": "HumanName.family.extension.valueString",
"sliceName": "valueString"
}, {
"id": "HumanName.family.extension:humannamePartnerPrefix",
"path": "HumanName.family.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
} ],
"alias": [ "VoorvoegselGeslachtsnaamPartner" ],
"short": "PrefixSurname",
"mapping": [ {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"sliceName": "humannamePartnerPrefix",
"definition": "Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable."
}, {
"id": "HumanName.family.extension:humannamePartnerPrefix.valueString:valueString",
"path": "HumanName.family.extension.valueString",
"sliceName": "valueString"
}, {
"path": "HumanName.family.extension",
"definition": "Partner’s official last name.",
"short": "LastNamePartner",
"mapping": [ {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
} ],
"sliceName": "humannamePartnerName",
"alias": [ "GeslachtsnaamPartner" ],
"id": "HumanName.family.extension:humannamePartnerName",
"comment": "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\"."
}, {
"id": "HumanName.family.extension:humannamePartnerName.valueString:valueString",
"path": "HumanName.family.extension.valueString",
"sliceName": "valueString"
}, {
"id": "HumanName.given",
"path": "HumanName.given",
"alias": [ "Voornamen", "Initialen", "Roepnaam" ],
"short": "Given",
"comment": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: _BR_, _IN_ and _CL_. The qualifier _BR_ maps to the HCIM concept FirstNames, _IN_ maps to Initials and _CL_ to GivenName.\r\n\r\nPlease see the compatibility note on the containing element as well!",
"mapping": [ {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "02.10",
"comment": "Voornamen",
"identity": "BRP"
}, {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.4",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.5",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.6",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"definition": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot."
}, {
"id": "HumanName.given.extension",
"path": "HumanName.given.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HumanName.given.extension:iso21090EnQualifier",
"max": "1",
"path": "HumanName.given.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
} ],
"sliceName": "iso21090EnQualifier"
}, {
"id": "HumanName.given.extension:iso21090EnQualifier.valueCode:valueCode",
"path": "HumanName.given.extension.valueCode",
"sliceName": "valueCode"
} ]
},
"contact": [ {
"name": "Nictiz",
"telecom": [ {
"use": "work",
"value": "https://www.nictiz.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName"
}