CH Core (R4)
1.0.0 - Trial use

This page is part of the CH Core (R4) (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0-ballot. For a full list of available versions, see the Directory of published versions

StructureDefinition: CHCoreHumanName

Name with extensions for ech-11

The official URL for this profile is:

http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-humanname

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*HumanNameName 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..1stringFamily name (often called 'Surname')
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*HumanNameName 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
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
... family ΣI0..1stringFamily name (often called 'Surname')
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-name I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-firstname I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period ΣI0..1PeriodTime period when name was/is in use

doco Documentation for this format

This structure is derived from HumanName

Differential View

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*HumanNameName 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..1stringFamily name (often called 'Surname')
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-firstname 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*HumanNameName 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
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
... family ΣI0..1stringFamily name (often called 'Surname')
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-name I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-11-firstname I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period ΣI0..1PeriodTime period when name was/is in use

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
HumanName.userequiredNameUse

Constraints

Constraints

IdPathDetailsRequirements
ele-1HumanNameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ch-core-hm-1HumanNameif 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 valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official')
ch-core-hm-2HumanNameif 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 valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden'))
ch-core-hm-3HumanNamech-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-4HumanNamech-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()
ele-1HumanName.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.familyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.family.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.family.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.family.extension:ech11nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.family.extension:ech11nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.givenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.given.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.given.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.given.extension:ech11firstnameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.given.extension:ech11firstnameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.suffixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())