Human Name

$10 / year

Human Name includes a name of a human with text, parts and usage information. The given name parts may contain whitespace, though generally they don’t. Initials may be used in place of the full name if that is all that is recorded. Systems that operate across cultures should generally rely on the text form for presentation and use the parts for index/search functionality. For this reason, applications should populate the text element for future robustness.

Complexity

Names may be changed or repudiated. 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 is not always significant. 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 shall care about name parts around the world varies widely. The multiple given parts and family name combine to form a single name. Where a person has alternate names that may be used in place of each other (e.g. Nicknames, Aliases), these are different instances of Human Name.

The text element specifies the entire name as it should be displayed e.g. in an application User Interface (UI). This may be provided instead of or as well as the specific 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. The correct order of assembly of the parts is culture dependent: the order of the parts within a given part type has significance and shall be observed. The appropriate order between family name and given names depends on culture and context of use. Note that there is an extension for the few times name assembly order is not fixed by the culture.

In some cultures (e.g. German, Dutch, Spanish, Portuguese), family names are complex and composed of various parts that may need to be managed separately, e.g. they have differing significance for searching. In these cases, the full family name is populated in family, and a decomposition of the name can be provided using the family extensions own-name, own-prefix, partner-name, partner-prefix, fathers-family and mothers-family.

For robust search, servers should search the parts of a family name independently. E.g. Searching either Carreno or Quinones should match a family name of “Carreno Quinones”. Health Level Seven International (HL7) affiliates, and others producing implementation guides, may make more specific recommendations about how search should work in specific cultures or environments.

Human Name is used in the following places:
– Insurance Plan
– Organization
– Patient
– Person
– Practitioner
– Related Person

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Human Name Datatype, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
EnumThe enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsEnum
HumanNameid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
HumanNameextensionarrayMay 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.{'$ref': '#/definitions/Extension'}
HumanNameuseIdentifies the purpose for this name.['usual' 'official' 'temp' 'nickname'
HumanName_use#/definitions/ElementExtensions for use
HumanNametext#/definitions/stringSpecifies 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.
HumanName_text#/definitions/ElementExtensions for text
HumanNamefamily#/definitions/stringThe 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.
HumanName_family#/definitions/ElementExtensions for family
HumanNamegivenarrayGiven name.{'$ref': '#/definitions/string'}
HumanName_givenarrayExtensions for given{'$ref': '#/definitions/Element'}
Related Data Packages