UK Core Implementation Guide 0.3.0 STU1

HumanName

A name of a human with text, parts and usage information.

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 HumanName datatype has the following elements and this is an overview of the datatype with additional UK Core guidance. The full definition is available from the FHIR standard.

Element type Usage Guidance Description
use code should be present Identifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names.Applications can assume that a name is current unless it explicitly says that it is temporary or old.
text string may be present Short description Text representation of the full name. 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. 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.
family string should be present Family name (often called 'Surname')
given string should be present Given names (not always 'first'). Includes middle names. This repeating element order: Given Names appear in the correct order for presenting the name
prefix string may be present Parts that come before the name. This repeating element order: Prefixes appear in the correct order for presenting the name
suffix string may be present Parts that come after the name. This repeating element order: Suffixes appear in the correct order for presenting the name
period Period may be present Time period when name was/is in use

Additional Information and Guidance

This section contains extra guidance and information about the use of this datatype in the UK Core FHIR implementations.

use

Identifies the purpose for this name.

HTML View

This code system http://hl7.org/fhir/name-use defines the following codes:

LvlCodeDisplayDefinition
1usualUsualKnown as/conventional/the one you normally use.
1officialOfficialThe formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
1tempTempA temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.
1nicknameNicknameA name that is used to address the person in an informal manner, but is not part of their formal or usual name.
1anonymousAnonymousAnonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
1oldOldThis name is no longer in use (or was never correct, but retained for records).
2  maidenName changed for MarriageA name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a 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.

Table View

CodeSystem.id[0]name-use
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]fhir
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/name-use
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.66
CodeSystem.version[0]4.0.1
CodeSystem.name[0]NameUse
CodeSystem.title[0]NameUse
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The use of a human name.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/name-use
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]usual
CodeSystem.concept[0].display[0]Usual
CodeSystem.concept[0].definition[0]Known as/conventional/the one you normally use.
CodeSystem.concept[1].code[0]official
CodeSystem.concept[1].display[0]Official
CodeSystem.concept[1].definition[0]The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
CodeSystem.concept[2].code[0]temp
CodeSystem.concept[2].display[0]Temp
CodeSystem.concept[2].definition[0]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.
CodeSystem.concept[3].code[0]nickname
CodeSystem.concept[3].display[0]Nickname
CodeSystem.concept[3].definition[0]A name that is used to address the person in an informal manner, but is not part of their formal or usual name.
CodeSystem.concept[4].code[0]anonymous
CodeSystem.concept[4].display[0]Anonymous
CodeSystem.concept[4].definition[0]Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
CodeSystem.concept[5].code[0]old
CodeSystem.concept[5].display[0]Old
CodeSystem.concept[5].definition[0]This name is no longer in use (or was never correct, but retained for records).
CodeSystem.concept[5].concept[0].code[0]maiden
CodeSystem.concept[5].concept[0].display[0]Name changed for Marriage
CodeSystem.concept[5].concept[0].definition[0]A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a 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.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="name-use" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/name-use" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.66" />
    </identifier>
    <version value="4.0.1" />
    <name value="NameUse" />
    <title value="NameUse" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The use of a human name." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/name-use" />
    <content value="complete" />
    <concept>
        <code value="usual" />
        <display value="Usual" />
        <definition value="Known as/conventional/the one you normally use." />
    </concept>
    <concept>
        <code value="official" />
        <display value="Official" />
        <definition value="The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called &quot;legal name&quot;." />
    </concept>
    <concept>
        <code value="temp" />
        <display value="Temp" />
        <definition value="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." />
    </concept>
    <concept>
        <code value="nickname" />
        <display value="Nickname" />
        <definition value="A name that is used to address the person in an informal manner, but is not part of their formal or usual name." />
    </concept>
    <concept>
        <code value="anonymous" />
        <display value="Anonymous" />
        <definition value="Anonymous assigned name, alias, or pseudonym (used to protect a person&#39;s identity for privacy reasons)." />
    </concept>
    <concept>
        <code value="old" />
        <display value="Old" />
        <definition value="This name is no longer in use (or was never correct, but retained for records)." />
        <concept>
            <code value="maiden" />
            <display value="Name changed for Marriage" />
            <definition value="A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a 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&#39;s name." />
        </concept>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "name-use",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/name-use",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.66"
        }
    ],
    "version": "4.0.1",
    "name": "NameUse",
    "title": "NameUse",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The use of a human name.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/name-use",
    "content": "complete",
    "concept":  [
        {
            "code": "usual",
            "display": "Usual",
            "definition": "Known as/conventional/the one you normally use."
        },
        {
            "code": "official",
            "display": "Official",
            "definition": "The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called \"legal name\"."
        },
        {
            "code": "temp",
            "display": "Temp",
            "definition": "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."
        },
        {
            "code": "nickname",
            "display": "Nickname",
            "definition": "A name that is used to address the person in an informal manner, but is not part of their formal or usual name."
        },
        {
            "code": "anonymous",
            "display": "Anonymous",
            "definition": "Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)."
        },
        {
            "code": "old",
            "display": "Old",
            "definition": "This name is no longer in use (or was never correct, but retained for records).",
            "concept":  [
                {
                    "code": "maiden",
                    "display": "Name changed for Marriage",
                    "definition": "A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a 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."
                }
            ]
        }
    ]
}

Unstructured Names

text

Text representation of the name. This should only be used if a structured name as detailed below cannot be supported. It may be present in addition to a structured name.

Structured Names

Structured names should be used whenever possible as detailed below.

The following elements should be used to construct structured names:

element example
family Smith
given John
prefix Mr
suffix MBE

back to top