HumanName

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

Definition

For further information, including all W3C International Examples, consult the HL7-FHIR examples. Note: Implementers should read the name examples for a full understanding of how name works.

Type

humanname

Attributes

Key

Type

Cardinality

Description

prefix

symbol

0..*

Parts that come before the name.

given

symbol

0..*

Given names (not always 'first'). Includes middle names.

family

symbol

0..1

The part of a name that links to the genealogy.

suffix

symbol

0..*

Parts that come after the name.

text

symbol

0..1

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

use

code

0..1

Purpose of this name.

Proposed values are:

  • usual: Known as/conventional/the one you normally use.
  • official: The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
  • temp: A temporary name. name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.
  • nickname: A name that is used to address the person in an informal manner, but is not part of their formal or usual name.
  • anonymous: Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
  • old: This name is no longer in use (or was never correct, but retained for records).
  • maiden: A name used prior to changing name because of marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name.

period

period

0..1

Time period when name was/is in use.

{
  "prefix": ["<symbol>"],
  "given": ["<symbol>"],
  "family": "<symbol>",
  "suffix": ["<symbol>"],
  "use": "<code>",
  "period": { Period }
}