FHIR IG analytics
| Package | nictiz.fhir.nl.r4.nl-core |
| Resource Type | StructureDefinition |
| Id | nl-core-NameInformation.json |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.nl-core@0.12.0-labtrial.1&canonical=http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation |
| URL | http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation |
| Status | draft |
| Name | NlcoreNameInformation |
| Title | nl core NameInformation |
| Realm | nl |
| Description | A person's official name information, including given names, last name and possibly the partner's last name. |
| Purpose | A derived profile from [zib-NameInformation](http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
For the entire zib, the complementary profile [nl-core-NameInformation.GivenName](http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName) should be used. Both profiles can be added in a slice with the discriminator set to `value`/`use`. |
| 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 |
| Kind | complex-type |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.
Source1
{
"resourceType": "StructureDefinition",
"id": "nl-core-NameInformation",
"text": {
"status": "empty",
"div": "<!-- snip (see above) -->"
},
"url": "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation",
"name": "NlcoreNameInformation",
"title": "nl core NameInformation",
"status": "draft",
"publisher": "Nictiz",
"contact": [
{
"name": "Nictiz",
"telecom": [
{
"system": "url",
"value": "https://www.nictiz.nl",
"use": "work"
}
]
}
],
"description": "A person's official name information, including given names, last name and possibly the partner's last name.",
"purpose": "A derived profile from [zib-NameInformation](http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.\r\n\r\nFor the entire zib, the complementary profile [nl-core-NameInformation.GivenName](http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName) should be used. Both profiles can be added in a slice with the discriminator set to `value`/`use`.",
"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-nameinformation-v1.1-2020EN",
"uri": "https://zibs.nl/wiki/NameInformation-v1.1(2020EN)",
"name": "zib NameInformation-v1.1(2020EN)"
}
],
"kind": "complex-type",
"abstract": false,
"type": "HumanName",
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "HumanName",
"path": "HumanName",
"short": "NameInformation",
"definition": "This slice represents the person's official name information, including given names, last name and possibly the partner's last name.",
"comment": "This `.name` element accomodates the official parts of a Dutch name according to common international usage and optionally to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on `.family` and on `.extension:nameUsage` for more information.\r\n\r\nSystems that need to work in a Dutch context SHOULD support the extensions as specified in `.given`, `.family` and `.extension:nameUsage`. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:\r\n* If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name.\r\n* If parts of the family name are specified using the extensions in `.family`, the `.family` element SHOULD be populated with the full family name.\r\n\r\n**Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the zib is mapped to FHIR.",
"alias": [
"Naamgegevens",
"nl-core-NameInformation"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "zib-NameInformation-1",
"severity": "error",
"human": "If a prefix for a family name is specified, the family name is expected as well",
"expression": "family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation"
},
{
"key": "zib-NameInformation-2",
"severity": "error",
"human": "If the prefix for a partner family name is specified, the partner family name is expected as well",
"expression": "family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation"
},
{
"key": "nl-core-NameInformation-01",
"severity": "warning",
"human": "If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.",
"expression": "(family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()",
"source": "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN"
},
{
"identity": "rim",
"map": "EN (actually, PN)"
},
{
"identity": "servd",
"map": "ProviderName"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.1",
"comment": "NameInformation"
}
]
},
{
"id": "HumanName.id",
"path": "HumanName.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.extension",
"path": "HumanName.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.extension:nameUsage",
"path": "HumanName.extension",
"sliceName": "nameUsage",
"short": "Preferred display order of name parts",
"definition": "A code that represents the preferred display order of the components of this human name.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.extension:nameUsage.id",
"path": "HumanName.extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.extension:nameUsage.extension",
"path": "HumanName.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.extension:nameUsage.url",
"path": "HumanName.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.extension:nameUsage.value[x]",
"path": "HumanName.extension.value[x]",
"short": "NameUsage",
"definition": "This concept indicates the last name or order of last names with which the person is to be addressed.",
"alias": [
"Naamgebruik"
],
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HumanNameAssemblyOrder"
}
],
"strength": "required",
"description": "Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.",
"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": "http://nictiz.nl/fhir/ConceptMap/NaamgebruikCodelijst-to-HumanNameAssemblyOrder"
}
]
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.7",
"comment": "NameUsage"
}
]
},
{
"id": "HumanName.use",
"path": "HumanName.use",
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"definition": "Identifies the purpose for this name.",
"comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 1,
"max": "1",
"base": {
"path": "HumanName.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"patternCode": "official",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
}
],
"strength": "required",
"description": "The use of a human name.",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN.7, but often indicated by which field contains the name"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./NamePurpose"
}
]
},
{
"id": "HumanName.text",
"path": "HumanName.text",
"short": "Text representation of the full name",
"definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"comment": "A representation of the full name, including given names and the family name.\r\n\r\nWhen implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.",
"requirements": "A renderable, unencoded form.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1",
"nl-core-NameInformation-01"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "implied by XPN.11"
},
{
"identity": "rim",
"map": "./formatted"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.4",
"comment": "FirstNames (implicit, main mapping is on .given)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.5",
"comment": "Initials (implicit, main mapping is on .given)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.7",
"comment": "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.11",
"comment": "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.10",
"comment": "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id": "HumanName.family",
"path": "HumanName.family",
"short": "Family name (often called 'Surname')",
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment": "When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept.",
"alias": [
"surname"
],
"min": 0,
"max": "1",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1",
"nl-core-NameInformation-01"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "nl-core-NameInformation-02",
"severity": "warning",
"human": "If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.",
"expression": "(extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()",
"source": "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN.1/FN.1"
},
{
"identity": "rim",
"map": "./part[partType = FAM]"
},
{
"identity": "servd",
"map": "./FamilyName"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.7",
"comment": "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.11",
"comment": "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.10",
"comment": "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id": "HumanName.family.id",
"path": "HumanName.family.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.family.extension",
"path": "HumanName.family.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:prefix",
"path": "HumanName.family.extension",
"sliceName": "prefix",
"short": "Voorvoegsel derived from person's own surname",
"definition": "The prefix portion (e.g. voorvoegsel) 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.",
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "v2",
"map": "FN.2"
},
{
"identity": "rim",
"map": "ENXP where Qualifiers = (VV, R)"
}
]
},
{
"id": "HumanName.family.extension:prefix.id",
"path": "HumanName.family.extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.family.extension:prefix.extension",
"path": "HumanName.family.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:prefix.url",
"path": "HumanName.family.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:prefix.value[x]",
"path": "HumanName.family.extension.value[x]",
"short": "Prefix",
"definition": "Prefix to the person’s own last name.",
"alias": [
"Voorvoegsels"
],
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.11",
"comment": "Prefix"
}
]
},
{
"id": "HumanName.family.extension:lastName",
"path": "HumanName.family.extension",
"sliceName": "lastName",
"short": "Portion derived from person's own surname",
"definition": "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.",
"comment": "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\".",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-own-name"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "v2",
"map": "FN.3"
},
{
"identity": "rim",
"map": "ENXP where Qualifiers = (BR)"
}
]
},
{
"id": "HumanName.family.extension:lastName.id",
"path": "HumanName.family.extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.family.extension:lastName.extension",
"path": "HumanName.family.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:lastName.url",
"path": "HumanName.family.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:lastName.value[x]",
"path": "HumanName.family.extension.value[x]",
"short": "LastName",
"definition": "The person’s official last name",
"alias": [
"Achternaam"
],
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.10",
"comment": "LastName"
}
]
},
{
"id": "HumanName.family.extension:partnerPrefix",
"path": "HumanName.family.extension",
"sliceName": "partnerPrefix",
"short": "Voorvoegsel derived from person's partner's surname",
"definition": "The prefix portion (e.g. voorvoegsel) 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.",
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "v2",
"map": "FN.4"
},
{
"identity": "rim",
"map": "ENXP where Qualifiers = (VV, SP)"
}
]
},
{
"id": "HumanName.family.extension:partnerPrefix.id",
"path": "HumanName.family.extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.family.extension:partnerPrefix.extension",
"path": "HumanName.family.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:partnerPrefix.url",
"path": "HumanName.family.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:partnerPrefix.value[x]",
"path": "HumanName.family.extension.value[x]",
"short": "PartnerPrefix",
"definition": "Prefix to the partner’s last name.",
"alias": [
"VoorvoegselsPartner"
],
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix"
}
]
},
{
"id": "HumanName.family.extension:partnerLastName",
"path": "HumanName.family.extension",
"sliceName": "partnerLastName",
"short": "Portion derived from person's partner's surname",
"definition": "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.",
"comment": "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\".",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "v2",
"map": "FN.5"
},
{
"identity": "rim",
"map": "ENXP where Qualifiers = (SP)"
}
]
},
{
"id": "HumanName.family.extension:partnerLastName.id",
"path": "HumanName.family.extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.family.extension:partnerLastName.extension",
"path": "HumanName.family.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:partnerLastName.url",
"path": "HumanName.family.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.family.extension:partnerLastName.value[x]",
"path": "HumanName.family.extension.value[x]",
"short": "PartnerLastName",
"definition": "Partner’s official last name.",
"alias": [
"AchternaamPartner"
],
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName"
}
]
},
{
"id": "HumanName.family.value",
"path": "HumanName.family.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "Primitive value for string",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"maxLength": 1048576
},
{
"id": "HumanName.given",
"path": "HumanName.given",
"short": "FirstName / Initial",
"definition": "One of a person’s official first names or the initial if the full name is not known.",
"comment": "This element can be used to represent full given names or initials. `extension:givenOrInitial` SHALL be used on each repretition to specifiy if it's a full name (_BR_) or an initial (_IN_).\r\n\r\n## Zib compatibility\r\n\r\nTthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.\r\n\r\nTherefore, the zib concepts are implemented here in the following way:\r\n\r\n* Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).\r\n* Each of these elements:\r\n * SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.\r\n * As noted, it SHALL be augmented with `extension:givenOrInitial`.\r\n\r\nInitials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.\r\n\r\nIf a system _does_ however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.\r\n\r\n**Note 1:** The GivenName concept should not be included here but in a separate `.name` instance where `.use` = _usual_.\r\n\r\n**Note 2**: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.",
"alias": [
"first name",
"middle name",
"Voornaam",
"Initiaal"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"condition": [
"ele-1",
"nl-core-NameInformation-01"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN.2 + XPN.3"
},
{
"identity": "rim",
"map": "./part[partType = GIV]"
},
{
"identity": "servd",
"map": "./GivenNames"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.4",
"comment": "FirstNames"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.5",
"comment": "Initials"
}
]
},
{
"id": "HumanName.given.id",
"path": "HumanName.given.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HumanName.given.extension",
"path": "HumanName.given.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HumanName.given.extension:givenOrInitial",
"path": "HumanName.given.extension",
"sliceName": "givenOrInitial",
"short": "LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV",
"definition": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.",
"comment": "Used to indicate additional information about the name part and how it should be used.",
"alias": [
"extensions",
"user content"
],
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "ENXP.qualifier"
}
]
},
{
"id": "HumanName.given.value",
"path": "HumanName.given.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "Primitive value for string",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"maxLength": 1048576
},
{
"id": "HumanName.prefix",
"path": "HumanName.prefix",
"short": "Titles",
"definition": "Noble and scientific titles. These can assist in formulating oral and formal addresing titles.",
"comment": "The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib 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 zib 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.",
"alias": [
"Titels"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN.5"
},
{
"identity": "rim",
"map": "./part[partType = PFX]"
},
{
"identity": "servd",
"map": "./TitleCode"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.12",
"comment": "Titles"
}
]
},
{
"id": "HumanName.suffix",
"path": "HumanName.suffix",
"short": "Titles",
"definition": "Noble and scientific titles. These can assist in formulating oral and formal addresing titles.",
"comment": "The zib concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the zib 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 zib 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.",
"alias": [
"Titels"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN/4"
},
{
"identity": "rim",
"map": "./part[partType = SFX]"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.12",
"comment": "Titles"
}
]
},
{
"id": "HumanName.period",
"path": "HumanName.period",
"short": "Time period when name was/is in use",
"definition": "Indicates the period of time when this name was valid for the named person.",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity": "v2",
"map": "XPN.13 + XPN.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
}
]
},
"differential": {
"element": [
{
"id": "HumanName",
"path": "HumanName",
"comment": "This `.name` element accomodates the official parts of a Dutch name according to common international usage and optionally to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on `.family` and on `.extension:nameUsage` for more information.\r\n\r\nSystems that need to work in a Dutch context SHOULD support the extensions as specified in `.given`, `.family` and `.extension:nameUsage`. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:\r\n* If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name.\r\n* If parts of the family name are specified using the extensions in `.family`, the `.family` element SHOULD be populated with the full family name.\r\n\r\n**Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the zib is mapped to FHIR.",
"alias": [
"nl-core-NameInformation"
],
"constraint": [
{
"key": "nl-core-NameInformation-01",
"severity": "warning",
"human": "If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.",
"expression": "(family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()"
}
]
},
{
"id": "HumanName.text",
"path": "HumanName.text",
"comment": "A representation of the full name, including given names and the family name.\r\n\r\nWhen implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.",
"condition": [
"nl-core-NameInformation-01"
],
"mapping": [
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.4",
"comment": "FirstNames (implicit, main mapping is on .given)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.5",
"comment": "Initials (implicit, main mapping is on .given)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.7",
"comment": "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.11",
"comment": "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.10",
"comment": "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id": "HumanName.family",
"path": "HumanName.family",
"comment": "When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept.",
"condition": [
"nl-core-NameInformation-01"
],
"constraint": [
{
"key": "nl-core-NameInformation-02",
"severity": "warning",
"human": "If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.",
"expression": "(extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()"
}
],
"mapping": [
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.7",
"comment": "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.11",
"comment": "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.10",
"comment": "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity": "zib-nameinformation-v1.1-2020EN",
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id": "HumanName.given",
"path": "HumanName.given",
"comment": "This element can be used to represent full given names or initials. `extension:givenOrInitial` SHALL be used on each repretition to specifiy if it's a full name (_BR_) or an initial (_IN_).\r\n\r\n## Zib compatibility\r\n\r\nTthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.\r\n\r\nTherefore, the zib concepts are implemented here in the following way:\r\n\r\n* Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).\r\n* Each of these elements:\r\n * SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.\r\n * As noted, it SHALL be augmented with `extension:givenOrInitial`.\r\n\r\nInitials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.\r\n\r\nIf a system _does_ however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.\r\n\r\n**Note 1:** The GivenName concept should not be included here but in a separate `.name` instance where `.use` = _usual_.\r\n\r\n**Note 2**: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.",
"condition": [
"nl-core-NameInformation-01"
]
}
]
}
}
FHIR
FHIRsmith