HumanName

General information

See HL7 HumanName for general information regarding the HumanName data type.

Scope and Usage

This profile defines how HumanName should be used for representing person and personnel names in Swedish healthcare contexts. It specifies which elements are mandatory, optional, or repeatable, and provides guidance on terminology bindings where relevant. The profile is intended for use in multiple FHIR resources that include names, such as Patient, Practitioner, Person, and RelatedPerson. It supports consistent data entry, validation, and interoperability across systems.

Boundaries and Relationships

The profile focuses on human-readable names and does not include identifiers, addresses, or other contact details. HumanName may be linked to identifiers or other demographic data via the containing resource (e.g., Patient.identifier or Practitioner.identifier). Multiple HumanName entries can exist for a single person to support historical names, legal names, or preferred names, but each should clearly indicate its purpose through the use element.

Background and Context

The HumanName data type is widely used across healthcare and administrative resources in FHIR. Standardizing its usage in Sweden ensures that person names are represented consistently across local, regional, and national systems, supporting interoperability, data exchange, and regulatory compliance. This profile uses profiling from the HL7 Sweden base profile for HumanName which is specific to Swedish healthcare practice, including requirements for cardinality, usage, and representation of multiple name components.

Profile

NPPRHumanName (HumanName)			HumanName	There are no (further) constraints on this element Element id HumanName Short description Name of a human or other living entity - parts and usage Definition A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information. 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 Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	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 managable, 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 Slicing 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
middleName	S C	0..1	Extension(string)	Element id HumanName.extension:middleName Short description Optional Extensions Element Alternate names extensions, user content Definition Extension for HumanName to express middle names. 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://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension 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	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element 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())` Mappings rim: n/a v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
text	S Σ	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	S Σ	0..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
given	S Σ	0..*	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
id		0..1	string	There are no (further) constraints on this element Element id HumanName.given.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 Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	Element id HumanName.given.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 managable, 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 Slicing 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
nameQualifier	S C	0..1	Extension(code)	Element id HumanName.given.extension:nameQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim: ENXP.qualifier
value		0..1	System.String	There are no (further) constraints on this element Element id HumanName.given.value Short description Primitive value for string Definition Primitive value for string Data type System.String Maximum string length 1048576
prefix	Σ	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 1,048,576 (10241024) characters 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..*	string	There are no (further) constraints on this element 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 1,048,576 (10241024) characters 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/4 rim: ./part[partType = SFX]
period	Σ C	0..1	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 or equal value than end `start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())` 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
Short	Name of a human or other living entity - parts and usage
Definition	A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
Cardinality	0..*
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.
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
HumanName.id
Short	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.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
HumanName.extension
Short	Additional content defined by implementations
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 managable, 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.
Cardinality	0..*
Type	Extension
Alias	extensions, 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.
Slicing	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
HumanName.extension:middleName
Short	Optional Extensions Element
Definition	Extension for HumanName to express middle names.
Cardinality	0..1
Type	Extension(string)
Must Support	True
Alias	extensions, 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.
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
HumanName.use
Short	usual \| official \| temp \| nickname \| anonymous \| old \| maiden
Definition	Identifies the purpose for this name.
Cardinality	0..1
Type	code
Binding	The use of a human name. NameUse (required)
Modifier	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
HumanName.text
Short	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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
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
HumanName.family
Short	Family name (often called '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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
Alias	surname
Comments	Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
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
HumanName.given
Short	Given names (not always 'first'). Includes middle names
Definition	Given name.
Cardinality	0..*
Type	string
Must Support	True
Summary	True
Alias	first name, middle 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.
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
HumanName.given.id
Short	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.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
HumanName.given.extension
Short	Additional content defined by implementations
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 managable, 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.
Cardinality	0..*
Type	Extension
Alias	extensions, 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.
Slicing	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
HumanName.given.extension:nameQualifier
Short	LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV
Definition	A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Cardinality	0..1
Type	Extension(code)
Must Support	True
Alias	extensions, user content
Comments	Used to indicate additional information about the name part and how it should be used.
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 rim: ENXP.qualifier
HumanName.given.value
Short	Primitive value for string
Definition	Primitive value for string
Cardinality	0..1
Type	System.String
Maximum string length	1048576
HumanName.prefix
Short	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.
Cardinality	0..*
Type	string
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
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
HumanName.suffix
Short	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.
Cardinality	0..*
Type	string
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
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]
HumanName.period
Short	Time period when name was/is in use
Definition	Indicates the period of time when this name was valid for the named person.
Cardinality	0..1
Type	Period
Summary	True
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.
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 or equal value than end `start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())`
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

<id value="NPPRHumanName" />
<url value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRHumanName" />
<version value="0.1" />
<name value="NPPRHumanName" />
<status value="draft" />
<description value="Profile for representing the name of an individual, to include name qualifier." />
<fhirVersion value="5.0.0" />
<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.extension:middleName">
<path value="HumanName.extension" />
<sliceName value="middleName" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension" />
</type>
<mustSupport value="true" />
</element>
<element id="HumanName.text">
<path value="HumanName.text" />
<mustSupport value="true" />
</element>
<element id="HumanName.family">
<path value="HumanName.family" />
<mustSupport value="true" />
</element>
<element id="HumanName.given">
<path value="HumanName.given" />
<mustSupport value="true" />
</element>
<element id="HumanName.given.extension">
<path value="HumanName.given.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="HumanName.given.extension:nameQualifier">
<path value="HumanName.given.extension" />
<sliceName value="nameQualifier" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" />
</type>
<mustSupport value="true" />
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "NPPRHumanName",
"url": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRHumanName",
"version": "0.1",
"name": "NPPRHumanName",
"status": "draft",
"description": "Profile for representing the name of an individual, to include name qualifier.",
"fhirVersion": "5.0.0",
"kind": "complex-type",
"abstract": false,
"type": "HumanName",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HumanName",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "HumanName.extension:middleName",
"path": "HumanName.extension",
"sliceName": "middleName",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension"
]
}
],
"mustSupport": true
},
{
"id": "HumanName.text",
"path": "HumanName.text",
"mustSupport": true
},
{
"id": "HumanName.family",
"path": "HumanName.family",
"mustSupport": true
},
{
"id": "HumanName.given",
"path": "HumanName.given",
"mustSupport": true
},
{
"id": "HumanName.given.extension",
"path": "HumanName.given.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "HumanName.given.extension:nameQualifier",
"path": "HumanName.given.extension",
"sliceName": "nameQualifier",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
]
}
],
"mustSupport": true
}
]
}

}

Constraints

This section is not applicable to this resource and therefore contains no content.

Terminology Bindings

This section is not applicable to this resource and therefore contains no content.

Extensions

Path	URL
HumanName.extension	http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension
HumanName.given.extension	http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

Examples

Patient with middle name

Person with middle name

Person with link reference

Practitioner that has a prescriber code

RelatedPerson with structured address