HL7 Europe Laboratory Report
0.2.0-ci - ci-build 150

HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions

Data Type Profile: HumanNameEu - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the HumanName-eu data type profile.

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

0. HumanName
2. HumanName.family
Example<br/><b>spanish name</b>:Valero Iglesias
4. HumanName.family.extension
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
  • 6. HumanName.family.extension:fathersFamily
    Slice NamefathersFamily
    Control0..*
    TypeExtension(Fathers Family) (Extension Type: string)
    Example<br/><b>spanish name</b>:Valero
    8. HumanName.family.extension:mothersFamily
    Slice NamemothersFamily
    Control0..*
    TypeExtension(Mothers Family) (Extension Type: string)
    Example<br/><b>spanish name</b>:Iglesias
    10. HumanName.given
    Example<br/><b>spanish name</b>:Borja

    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()))
    2. 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()))
    4. 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
    Example<br/><b>spanish name</b>:Valero Iglesias
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. HumanName.family.extension
    Definition

    An Extension


    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.

    ShortExtensionAdditional 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())
    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
    • 8. HumanName.family.extension:fathersFamily
      Slice NamefathersFamily
      Definition

      The portion of the family name that is derived from the person's father.

      ShortPortion of family name derived from father
      Control0..*
      TypeExtension(Fathers Family) (Extension Type: string)
      Is Modifierfalse
      Example<br/><b>spanish name</b>:Valero
      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())
      ele-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.family.extension:mothersFamily
      Slice NamemothersFamily
      Definition

      The portion of the family name that is derived from the person's mother.

      ShortPortion of family name derived from mother
      Control0..*
      TypeExtension(Mothers Family) (Extension Type: string)
      Is Modifierfalse
      Example<br/><b>spanish name</b>:Iglesias
      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())
      ele-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())
      12. 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
      Example<br/><b>spanish name</b>:Borja
      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()))
      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.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()))
        8. 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()))
        10. 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
        Example<br/><b>spanish name</b>:Valero Iglesias
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. 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
        14. 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
        • 16. HumanName.family.extension:fathersFamily
          Slice NamefathersFamily
          Definition

          The portion of the family name that is derived from the person's father.

          ShortPortion of family name derived from father
          Control0..*
          TypeExtension(Fathers Family) (Extension Type: string)
          Is Modifierfalse
          Example<br/><b>spanish name</b>:Valero
          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())
          18. HumanName.family.extension:mothersFamily
          Slice NamemothersFamily
          Definition

          The portion of the family name that is derived from the person's mother.

          ShortPortion of family name derived from mother
          Control0..*
          TypeExtension(Mothers Family) (Extension Type: string)
          Is Modifierfalse
          Example<br/><b>spanish name</b>:Iglesias
          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())
          20. 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
          22. 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
          Example<br/><b>spanish name</b>:Borja
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. 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.

          ShortParts that come before 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()))
          26. 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()))
          28. 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()))