Shared Health Specification and Guide Version 2.0 Revision F

 

Definitions for the dtprofile-humanname Profile.

HumanName
Definition

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

Control0..*
Must Supporttrue
Comments

This data type is used to support both Practitioner names and Patient names. These name values are used for SAML validation (Practitioner) and eFax generation, and possibly patient matching algorithms.

Conformance Rule: For the purpose of presentation, the data elements will be organized as Prefix + Given1 + Given2 + Family + Suffix.

Max Length0
HumanName.id
Definition

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

Control0..1
Typeid
Max Length0
HumanName.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Max Length0
HumanName.use
Definition

Identifies the purpose for this name.

Control1..1
BindingThe codes SHALL be taken from SharedNameUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Max Length0
HumanName.text
Definition

A full text representation of the name.

Control0..1
Typestring
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

Max Length0
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.

Control1..1
Typestring
Must Supporttrue
Alternate Namessurname
Comments

Conformance rule: Family is not to include professional designations

Max Length0
HumanName.given
Definition

Given name.

Control1..2
Typestring
Must Supporttrue
Alternate Namesfirst name, middle name
Comments

Conformance Rule: Given name(s) is not to include profession designations

Max Length0
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.

Control0..1
Typestring
Must Supporttrue
Comments

Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

Max Length0
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.

Control0..1
Typestring
Must Supporttrue
Comments

Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

Max Length0
HumanName.period
Definition

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

Control0..1
TypePeriod
Requirements

Allows names to be placed in historical context.

Max Length0