CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot-2: DSTU 4 Ballot 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-epr-fhir-humanname | Version: 4.0.1-ballot-2 | |||
| Draft as of 2020-07-27 | Computable Name: ChEprFhirHumanName | |||
Copyright/Legal: CC0-1.0 |
||||
The humanname WITHOUT the ISO 21090 qualifier https://www.hl7.org/fhir/extension-iso21090-en-qualifier.html BR
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | 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 ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
  use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-core-hm-1 | error | HumanName | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : 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') | |
| ch-core-hm-2 | error | HumanName | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : 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')) | |
| ch-core-hm-3 | error | HumanName | ch-ext-ech-11-name can only be put on a family name : 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() | |
| ch-core-hm-4 | error | HumanName | ch-ext-ech-11-firstname can only be put on a given name : 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() | |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | 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 ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
 id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text |
Σ | 0..1 | string | Text representation of the full name |
 family |
Σ | 0..1 | string | Family name (often called 'Surname') |
 id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| given |
Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| 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. This repeating element order: Prefixes appear in the correct order for presenting the name |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
 period |
Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-core-hm-1 | error | HumanName | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : 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') | |
| ch-core-hm-2 | error | HumanName | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : 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')) | |
| ch-core-hm-3 | error | HumanName | ch-ext-ech-11-name can only be put on a family name : 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() | |
| ch-core-hm-4 | error | HumanName | ch-ext-ech-11-firstname can only be put on a given name : 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() | |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CHCoreHumanName
Differential View
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | 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 ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-core-hm-1 | error | HumanName | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : 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') | |
| ch-core-hm-2 | error | HumanName | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : 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')) | |
| ch-core-hm-3 | error | HumanName | ch-ext-ech-11-name can only be put on a family name : 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() | |
| ch-core-hm-4 | error | HumanName | ch-ext-ech-11-firstname can only be put on a given name : 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() | |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | 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 ch-epr-fhir-1: For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text |
Σ | 0..1 | string | Text representation of the full name |
| family |
Σ | 0..1 | string | Family name (often called 'Surname') |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| given |
Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| 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. This repeating element order: Prefixes appear in the correct order for presenting the name |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period |
Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-core-hm-1 | error | HumanName | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : 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') | |
| ch-core-hm-2 | error | HumanName | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : 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')) | |
| ch-core-hm-3 | error | HumanName | ch-ext-ech-11-name can only be put on a family name : 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() | |
| ch-core-hm-4 | error | HumanName | ch-ext-ech-11-firstname can only be put on a given name : 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() | |
| ch-epr-fhir-1 | error | HumanName | For birth name (iso21090-EN-qualifier BR) use slice 'name:BirthName' : family.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier' and value='BR').exists()=false | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CHCoreHumanName
Other representations of profile: CSV, Excel, Schematron