CH ELM (R4)
1.7.0-ci-build - ci-build Switzerland flag

CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.7.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions

Data Type Profile: CHElmHumanName - Detailed Descriptions

Active as of 2024-11-15

Definitions for the ch-elm-humanname data type profile.

Guidance on how to interpret the contents of this table can be found here

0. HumanName
2. HumanName.extension:vctcode
Slice Namevctcode
Control0..1
TypeExtension(CH ELM Extension: VCT code) (Extension Type: string)
4. HumanName.extension:hivcode
Slice Namehivcode
Control0..1
TypeExtension(CH ELM Extension: HIV code) (Extension Type: string)
6. HumanName.family
8. HumanName.family.extension:dataabsentreason
Slice Namedataabsentreason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
10. HumanName.given
12. HumanName.given.extension:dataabsentreason
Slice Namedataabsentreason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)

Guidance on how to interpret the contents of this table can be found here

0. HumanName
Definition

A human's name with the ability to identify parts and usage.

ShortName of a human - parts and usage
Comments

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.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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 (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: 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: 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: 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())
2. HumanName.extension:vctcode
Slice Namevctcode
Definition

This CH ELM extension enables to proivde the VCT Code.

ShortCH ELM Extension: VCT Code
Control0..1
TypeExtension(CH ELM Extension: VCT code) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. HumanName.extension:hivcode
Slice Namehivcode
Definition

This CH ELM extension enables to proivde the HIV Code.

ShortCH ELM Extension: HIV Code
Control0..1
TypeExtension(CH ELM Extension: HIV code) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. HumanName.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. HumanName
Definition

A human's name with the ability to identify parts and usage.

ShortName of a human - parts and usage
Comments

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.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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 (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: 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: 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: 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())
2. HumanName.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. HumanName.extension
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.

ShortAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on HumanName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. HumanName.extension:vctcode
    Slice Namevctcode
    Definition

    This CH ELM extension enables to proivde the VCT Code.

    ShortCH ELM Extension: VCT Code
    Control0..1
    TypeExtension(CH ELM Extension: VCT code) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. HumanName.extension:hivcode
    Slice Namehivcode
    Definition

    This CH ELM extension enables to proivde the HIV Code.

    ShortCH ELM Extension: HIV Code
    Control0..1
    TypeExtension(CH ELM Extension: HIV code) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. HumanName.use
    Definition

    Identifies the purpose for this name.

    Shortusual | official | temp | nickname | anonymous | old | maiden
    Comments

    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from NameUse
    (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

    The use of a human name.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate name for a particular context of use to be selected from among a set of names.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. HumanName.text
    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.

    ShortText representation of the full name
    Comments

    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    A renderable, unencoded form.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. HumanName.family
    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.

    ShortFamily name (often called 'Surname')
    Comments

    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate Namessurname
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. HumanName.family.id
    Definition

    unique id for the element within a resource (for internal references)

    Shortxml:id (or equivalent in JSON)
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    18. HumanName.family.extension
    Definition

    An Extension

    ShortExtension
    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on HumanName.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. HumanName.family.extension:ech11name
      Slice Nameech11name
      Definition

      Extension for eCH-0011 - namedatatype

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Name) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      22. HumanName.family.extension:dataabsentreason
      Slice Namedataabsentreason
      Definition

      Provides a reason why the expected value or elements in the element that is extended are missing.

      Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
      Control0..1
      TypeExtension(Data Absent Reason) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. HumanName.family.value
      Definition

      The actual value

      ShortPrimitive value for string
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Max Length:1048576
      26. HumanName.given
      Definition

      Given name.

      ShortGiven names (not always 'first'). Includes middle names
      Comments

      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.

      Control0..*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namesfirst name, middle name
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. HumanName.given.id
      Definition

      unique id for the element within a resource (for internal references)

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      30. HumanName.given.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on HumanName.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 32. HumanName.given.extension:ech11firstname
        Slice Nameech11firstname
        Definition

        eCH-0011: Extension to define first name type

        ShortExtension
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(First Name) (Extension Type: code)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. HumanName.given.extension:dataabsentreason
        Slice Namedataabsentreason
        Definition

        Provides a reason why the expected value or elements in the element that is extended are missing.

        Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
        Control0..1
        TypeExtension(Data Absent Reason) (Extension Type: code)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. HumanName.given.value
        Definition

        The actual value

        ShortPrimitive value for string
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Max Length:1048576
        38. HumanName.prefix
        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.

        ShortFor 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.
        Control0..*
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. HumanName.prefix.id
        Definition

        unique id for the element within a resource (for internal references)

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        42. HumanName.prefix.extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on HumanName.prefix.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 44. HumanName.prefix.extension:salutationandtitle
          Slice Namesalutationandtitle
          Definition

          A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

          ShortFor academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS.
          Comments

          Used to indicate additional information about the name part and how it should be used.

          Control0..*
          TypeExtension(EN Qualifier) (Extension Type: code)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          46. HumanName.prefix.value
          Definition

          The actual value

          ShortPrimitive value for string
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Max Length:1048576
          48. HumanName.suffix
          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.

          ShortParts that come after the name
          Control0..*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. HumanName.period
          Definition

          Indicates the period of time when this name was valid for the named person.

          ShortTime period when name was/is in use
          Control0..1
          TypePeriod
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows names to be placed in historical context.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))