| Package | ch.fhir.ig.ch-core |
| Type | StructureDefinition |
| Id | ch-core-humanname |
| FHIR Version | R4 |
| Source | http://fhir.ch/ig/ch-core/https://build.fhir.org/ig/hl7ch/ch-core/StructureDefinition-ch-core-humanname.html |
| URL | http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname |
| Version | 6.0.0-ci-build |
| Status | active |
| Date | 2025-05-22T06:27:11+00:00 |
| Name | CHCoreHumanName |
| Title | Human Name |
| Realm | ch |
| Authority | hl7 |
| Description | Name with extensions for ech-11 |
| Copyright | CC0-1.0 |
| Type | HumanName |
| Kind | complex-type |
| StructureDefinition | |
| ch-core-patient | CH Core Patient |
| ch-core-practitioner | CH Core Practitioner |
| ch-core-relatedperson | CH Core RelatedPerson |
| ch-elm-humanname | Human Name |
| ch-epr-fhir-birthname | CH EPR FHIR BirthName |
| ch-epr-fhir-humanname | CH EPR FHIR HumanName |
| ch-epr-mhealth-birthname | CH EPR mHealth BirthName |
| ch-epr-mhealth-humanname | CH EPR mHealth HumanName |
| ch-ems-patient | CH EMS Patient Profile |
| mni-humanName | MedNet Interface (MNI) - Human Name |
| ch-crl-organization | CH CRL Organization |
| StructureDefinition | |
| ch-ext-ech-11-firstname | First Name |
| ch-ext-ech-11-name | Name |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ch-core-humanname
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HumanName | C | 0..* | HumanName | Name of a human - parts and usage ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name |
 family | 0..1 | string | Family name (often called 'Surname') | |
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:ech11name | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) | |
| given | 0..* | string | Given names (not always 'first'). Includes middle names | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ech11firstname | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) | |
| prefix | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:salutationandtitle | 0..* | code | For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "ch-core-humanname",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname",
"version": "6.0.0-ci-build",
"name": "CHCoreHumanName",
"title": "Human Name",
"status": "active",
"date": "2025-05-22T06:27:11+00:00",
"publisher": "HL7 Switzerland",
"contact": [
{
"name": "HL7 Switzerland",
"telecom": [
{
"system": "url",
"value": "https://www.hl7.ch/"
}
]
},
{
"name": "HL7 Switzerland",
"telecom": [
{
"system": "url",
"value": "https://www.hl7.ch/",
"use": "work"
}
]
}
],
"description": "Name with extensions for ech-11",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CH"
}
]
}
],
"copyright": "CC0-1.0",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "eCH",
"uri": "http://www.ech.ch/",
"name": "eCH-Standards"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"kind": "complex-type",
"abstract": false,
"type": "HumanName",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "HumanName",
"path": "HumanName",
"short": "Name of a human - parts and usage",
"definition": "A human's name with the ability to identify parts and usage.",
"comment": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.",
"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": "ch-core-hm-1",
"severity": "error",
"human": "if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official",
"expression": "family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-2",
"severity": "error",
"human": "if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden",
"expression": "family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-3",
"severity": "error",
"human": "ch-ext-ech-11-name can only be put on a family name",
"expression": "descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-4",
"severity": "error",
"human": "ch-ext-ech-11-firstname can only be put on a given name",
"expression": "descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XPN"
},
{
"identity": "rim",
"map": "EN (actually, PN)"
},
{
"identity": "servd",
"map": "ProviderName"
}
]
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"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"
}
],
"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,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": 0,
"max": "1",
"base": {
"path": "HumanName.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"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": "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": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"requirements": "A renderable, unencoded form.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"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": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "implied by XPN.11"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"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": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"alias": [
"surname"
],
"min": 0,
"max": "1",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"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": false,
"isSummary": true,
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: lastName"
},
{
"identity": "v2",
"map": "XPN.1/FN.1"
},
{
"identity": "rim",
"map": "./part[partType = FAM]"
},
{
"identity": "servd",
"map": "./FamilyName"
}
]
},
{
"id": "HumanName.family.id",
"path": "HumanName.family.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"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"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.family.extension",
"path": "HumanName.family.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"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,
"isSummary": false
},
{
"id": "HumanName.family.extension:ech11name",
"path": "HumanName.family.extension",
"sliceName": "ech11name",
"short": "Extension",
"definition": "Extension for eCH-0011 - namedatatype",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "eCH",
"map": "eCH-0011: officialName, originalName, allianceName, nameOnForeignPassport, aliasName, otherName, declaredForeignName"
}
]
},
{
"id": "HumanName.family.value",
"path": "HumanName.family.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"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,
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.given",
"path": "HumanName.given",
"short": "Given names (not always 'first'). Includes middle names",
"definition": "Given name.",
"comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.",
"alias": [
"first name",
"middle name"
],
"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",
"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": false,
"isSummary": true,
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: firstName equivalent to callName of eCH-0011"
},
{
"identity": "v2",
"map": "XPN.2 + XPN.3"
},
{
"identity": "rim",
"map": "./part[partType = GIV]"
},
{
"identity": "servd",
"map": "./GivenNames"
}
]
},
{
"id": "HumanName.given.id",
"path": "HumanName.given.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"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"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.given.extension",
"path": "HumanName.given.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"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,
"isSummary": false
},
{
"id": "HumanName.given.extension:ech11firstname",
"path": "HumanName.given.extension",
"sliceName": "ech11firstname",
"short": "Extension",
"definition": "eCH-0011: Extension to define first name type",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname"
]
}
],
"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,
"isSummary": false,
"mapping": [
{
"identity": "eCH",
"map": "eCH-0011: officialFirstName, callName, allianceName, firstNameOnForeignPassport, declaredForeignFirstName"
}
]
},
{
"id": "HumanName.given.value",
"path": "HumanName.given.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"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,
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.prefix",
"path": "HumanName.prefix",
"short": "For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.",
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"min": 0,
"max": "*",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"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": false,
"isSummary": true,
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: mrMrs, title"
},
{
"identity": "v2",
"map": "XPN.5"
},
{
"identity": "rim",
"map": "./part[partType = PFX]"
},
{
"identity": "servd",
"map": "./TitleCode"
}
]
},
{
"id": "HumanName.prefix.id",
"path": "HumanName.prefix.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"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"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.prefix.extension",
"path": "HumanName.prefix.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"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,
"isSummary": false
},
{
"id": "HumanName.prefix.extension:salutationandtitle",
"path": "HumanName.prefix.extension",
"sliceName": "salutationandtitle",
"short": "For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier|5.2.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "ENXP.qualifier"
}
]
},
{
"id": "HumanName.prefix.value",
"path": "HumanName.prefix.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"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,
"isModifier": false,
"isSummary": false
},
{
"id": "HumanName.suffix",
"path": "HumanName.suffix",
"short": "Parts that come after the name",
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"min": 0,
"max": "*",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"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": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN/4"
},
{
"identity": "rim",
"map": "./part[partType = SFX]"
}
]
},
{
"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.",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"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": false,
"isSummary": true,
"mapping": [
{
"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",
"constraint": [
{
"key": "ch-core-hm-1",
"severity": "error",
"human": "if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official",
"expression": "family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-2",
"severity": "error",
"human": "if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden",
"expression": "family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-3",
"severity": "error",
"human": "ch-ext-ech-11-name can only be put on a family name",
"expression": "descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
},
{
"key": "ch-core-hm-4",
"severity": "error",
"human": "ch-ext-ech-11-firstname can only be put on a given name",
"expression": "descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()",
"source": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname"
}
]
},
{
"id": "HumanName.family",
"path": "HumanName.family",
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: lastName"
}
]
},
{
"id": "HumanName.family.extension",
"path": "HumanName.family.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
}
},
{
"id": "HumanName.family.extension:ech11name",
"path": "HumanName.family.extension",
"sliceName": "ech11name",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name"
]
}
],
"mapping": [
{
"identity": "eCH",
"map": "eCH-0011: officialName, originalName, allianceName, nameOnForeignPassport, aliasName, otherName, declaredForeignName"
}
]
},
{
"id": "HumanName.given",
"path": "HumanName.given",
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: firstName equivalent to callName of eCH-0011"
}
]
},
{
"id": "HumanName.given.extension",
"path": "HumanName.given.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
}
},
{
"id": "HumanName.given.extension:ech11firstname",
"path": "HumanName.given.extension",
"sliceName": "ech11firstname",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname"
]
}
],
"mapping": [
{
"identity": "eCH",
"map": "eCH-0011: officialFirstName, callName, allianceName, firstNameOnForeignPassport, declaredForeignFirstName"
}
]
},
{
"id": "HumanName.prefix",
"path": "HumanName.prefix",
"short": "For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.",
"mapping": [
{
"identity": "eCH",
"map": "eCH-0010: mrMrs, title"
}
]
},
{
"id": "HumanName.prefix.extension",
"path": "HumanName.prefix.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
}
},
{
"id": "HumanName.prefix.extension:salutationandtitle",
"path": "HumanName.prefix.extension",
"sliceName": "salutationandtitle",
"short": "For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier|5.2.0"
]
}
]
}
]
}
}