Human Name Obligations - Definitions - MyHealth@Eu Laboratory Report v0.0.1

MyHealth@Eu Laboratory Report
0.0.1 - qa-preview 150

This page is part of the MyHealth@Eu Laboratory Report (v0.0.1: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Type Profile: HumanNameEuObligations - Detailed Descriptions

Page standards status: Draft

Maturity Level: 0

Definitions for the HumanName-obl-lab-myhealtheu data type profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. HumanName

2. HumanName.family

Obligations

Obligations

Actor

4. HumanName.family.extension:fathersFamily

Slice Name

fathersFamily

Obligations

Obligations

Actor

6. HumanName.family.extension:mothersFamily

Slice Name

mothersFamily

Obligations

Obligations

Actor

8. HumanName.given

Obligations

Obligations

Actor

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.

Short Name 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.

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier false

Invariants ele-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.

Comments

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

Control 0..1

Binding

The 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.

Type

code

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-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.

Short Family name (often called 'Surname')

Comments

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

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Obligations

Obligations

Actor

Summary true

Alternate Names surname

Example spanish name:Valero Iglesias

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

6. HumanName.family.extension:fathersFamily

Slice Name fathersFamily

Definition

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

Short Portion of family name derived from father

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(fathers-family) (Extension Type: string)

Is Modifier false

Obligations

Obligations

Actor

Example spanish name:Valero

Invariants 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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

8. HumanName.family.extension:mothersFamily

Slice Name mothersFamily

Definition

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

Short Portion of family name derived from mother

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(mothers-family) (Extension Type: string)

Is Modifier false

Obligations

Obligations

Actor

Example spanish name:Iglesias

Invariants 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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

10. HumanName.given

Definition

Given name.

Short Given 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.

Control 0..*

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Obligations

Obligations

Actor

Summary true

Alternate Names first name, middle name

Example spanish name:Borja

Invariants ele-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.

Short Name 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.

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier false

Invariants ele-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.

Short Unique id for inter-element referencing

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

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.

Short Additional 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.

Control 0..*

Type

Extension

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants 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())

Slicing

This element introduces a set of slices on HumanName.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:

value @ url

6. HumanName.use

Definition

Identifies the purpose for this name.

Comments

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

Control 0..1

Binding

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

The use of a human name.

Type

code

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-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.

Short Text 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.

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-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.

Short Family name (often called 'Surname')

Comments

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

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Obligations

Obligations

Actor

Summary true

Alternate Names surname

Example spanish name:Valero Iglesias

Invariants ele-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)

Short xml:id (or equivalent in JSON)

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

14. HumanName.family.extension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier false

Summary false

Invariants 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())

Slicing

This element introduces a set of slices on HumanName.family.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:

value @ url

16. HumanName.family.extension:fathersFamily

Slice Name fathersFamily

Definition

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

Short Portion of family name derived from father

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(fathers-family) (Extension Type: string)

Is Modifier false

Obligations

Obligations

Actor

Example spanish name:Valero

Invariants 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())

18. HumanName.family.extension:mothersFamily

Slice Name mothersFamily

Definition

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

Short Portion of family name derived from mother

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(mothers-family) (Extension Type: string)

Is Modifier false

Obligations

Obligations

Actor

Example spanish name:Iglesias

Invariants 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())

20. HumanName.family.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length 1048576

22. HumanName.given

Definition

Given name.

Short Given 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.

Control 0..*

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Obligations

Obligations

Actor