CH EPR mHealth (R4)
0.2.0 - DSTU 1 Informative Ballot

CH EPR mHealth (R4), published by eHealth Suisse. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-mhealth/ and changes regularly. See the Directory of published versions

Data Type Profile: CH EPR mHealth BirthName

Defining URL:http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-epr-mhealth-birthname
Version:0.2.0
Name:ChEprMHealthBirthName
Title:CH EPR mHealth BirthName
Status:Draft as of 7/7/20, 12:00 AM
Definition:

The birthname with the ISO 21090 qualifier https://www.hl7.org/fhir/extension-iso21090-en-qualifier.html BR

Publisher:eHealth Suisse
Copyright:

CC-BY-SA-4.0

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-epr-mhealth-birthname

Formal Views of Profile Content

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

This structure is derived from CHCoreHumanName

Summary

Mandatory: 4 elements
Must-Support: 1 element
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

This structure is derived from CHCoreHumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*CHCoreHumanNameBirthName
... family S1..1stringThe birthname of the patient
.... Slices for extension 1..1ExtensionExtension
Slice: Unordered, Closed by value:url
..... iso21090-EN-qualifier 1..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

...... valueCode 1..1codeBR (Birth)
Fixed Value: BR

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*CHCoreHumanNameBirthName
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... family SΣ1..1stringThe birthname of the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 1..1ExtensionExtension
Slice: Unordered, Closed by value:url
..... ch-ext-ech-11-name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


..... iso21090-EN-qualifier 1..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
...... Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

....... value[x]:valueCode 1..1codeBR (Birth)
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


Fixed Value: BR
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for 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
Binding: eCH-011 FirstNameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... prefix Σ0..*stringFor 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..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-EN-qualifier 0..*codeFor 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): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

This structure is derived from CHCoreHumanName

Summary

Mandatory: 4 elements
Must-Support: 1 element
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CHCoreHumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*CHCoreHumanNameBirthName
... family S1..1stringThe birthname of the patient
.... Slices for extension 1..1ExtensionExtension
Slice: Unordered, Closed by value:url
..... iso21090-EN-qualifier 1..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

...... valueCode 1..1codeBR (Birth)
Fixed Value: BR

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*CHCoreHumanNameBirthName
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... family SΣ1..1stringThe birthname of the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 1..1ExtensionExtension
Slice: Unordered, Closed by value:url
..... ch-ext-ech-11-name 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name
Binding: eCH-011 NameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


..... iso21090-EN-qualifier 1..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
...... Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

....... value[x]:valueCode 1..1codeBR (Birth)
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


Fixed Value: BR
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for 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
Binding: eCH-011 FirstNameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... prefix Σ0..*stringFor 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..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-EN-qualifier 0..*codeFor 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): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
HumanName.userequiredNameUse
HumanName.family.extension:iso21090-EN-qualifier.value[x]requiredEntityNamePartQualifier
HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCoderequiredFixed Value: BR

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.family.extension:iso21090-EN-qualifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.family.extension:iso21090-EN-qualifierMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.family.extension:iso21090-EN-qualifier.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
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.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1HumanName.prefix.extension:salutationandtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1HumanName.prefix.extension:salutationandtitleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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())