Implementation Guide

BaseHumanName

Base Definition: http://hl7.org/fhir/StructureDefinition/HumanName

BaseHumanName (HumanName)			HumanName	There are no (further) constraints on this element Element id HumanName Short description Name of a human - parts and usage Definition A human's name with the ability to identify 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. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName
id		0..1	string	There are no (further) constraints on this element Element id HumanName.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id HumanName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
use	Σ ?!	1..1	codeBindingFixed Value	Element id HumanName.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data type code Binding The use of a human name. NameUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value official Mappings rim: n/a v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element id HumanName.text Short description Text representation of the full name 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. Requirements A renderable, unencoded form. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: implied by XPN.11 rim: ./formatted
family	Σ	1..1	string	There are no (further) constraints on this element Element id HumanName.family Short description Family name (often called 'Surname') Alternate names surname 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. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName
id		0..1	string	There are no (further) constraints on this element Element id HumanName.family.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	Element id HumanName.family.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
middle	I	0..1	Extension(string)	Element id HumanName.family.extension:middle Short description Portion of family name derived from mother Alternate names extensions, user content Definition The portion of the family name that is derived from the person's mother. 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. Data type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Constraints 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()` Mappings rim: n/a rim: N/A v2: N/A
value		0..1	System.String	There are no (further) constraints on this element Element id HumanName.family.value Short description Primitive value for string Definition Primitive value for string Data type System.String Maximum string length 1048576
given	Σ	1..1	string	There are no (further) constraints on this element Element id HumanName.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames
prefix	Σ	0..0	string	There are no (further) constraints on this element Element id HumanName.prefix Short description Parts that come before the name 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode
suffix	Σ	0..1	stringBinding	Element id HumanName.suffix Short description Parts that come after the name 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Binding Suffix_Name (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN/4 rim: ./part[partType = SFX]
period	Σ I	0..0	Period	There are no (further) constraints on this element Element id HumanName.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate

HumanName		..
HumanName.use		1..
HumanName.family		1..
HumanName.family.extension		0..
HumanName.family.extension	Extension	0..1
HumanName.given		1..1
HumanName.prefix		..0
HumanName.suffix		..1
HumanName.period		..0

<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="https://bghmc.org/fhir/StructureDefinition/BaseHumanName" />
    <name value="BaseHumanName" />
    <status value="draft" />
    <date value="2023-11-06T04:54:59.1556306+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <type value="HumanName" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/HumanName" />
    <derivation value="constraint" />
    <differential>
        <element id="HumanName.use">
            <path value="HumanName.use" />
            <min value="1" />
            <fixedCode value="official" />
        </element>
        <element id="HumanName.family">
            <path value="HumanName.family" />
            <min value="1" />
        </element>
        <element id="HumanName.family.extension">
            <path value="HumanName.family.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="HumanName.family.extension:middle">
            <path value="HumanName.family.extension" />
            <sliceName value="middle" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/humanname-mothers-family" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="HumanName.given">
            <path value="HumanName.given" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="HumanName.prefix">
            <path value="HumanName.prefix" />
            <max value="0" />
        </element>
        <element id="HumanName.suffix">
            <path value="HumanName.suffix" />
            <max value="1" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://bghmc.org/fhir/CodeSystem/SuffixName" />
            </binding>
        </element>
        <element id="HumanName.period">
            <path value="HumanName.period" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "url": "https://bghmc.org/fhir/StructureDefinition/BaseHumanName",
    "name": "BaseHumanName",
    "status": "draft",
    "date": "2023-11-06T04:54:59.1556306+00:00",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "type": "HumanName",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HumanName.use",
                "path": "HumanName.use",
                "min": 1,
                "fixedCode": "official"
            },
            {
                "id": "HumanName.family",
                "path": "HumanName.family",
                "min": 1
            },
            {
                "id": "HumanName.family.extension",
                "path": "HumanName.family.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "HumanName.family.extension:middle",
                "path": "HumanName.family.extension",
                "sliceName": "middle",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/humanname-mothers-family"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HumanName.given",
                "path": "HumanName.given",
                "min": 1,
                "max": "1"
            },
            {
                "id": "HumanName.prefix",
                "path": "HumanName.prefix",
                "max": "0"
            },
            {
                "id": "HumanName.suffix",
                "path": "HumanName.suffix",
                "max": "1",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://bghmc.org/fhir/CodeSystem/SuffixName"
                }
            },
            {
                "id": "HumanName.period",
                "path": "HumanName.period",
                "max": "0"
            }
        ]
    }
}