Healthcare Financial Services IG Edition 1
0.3.0 - ci-build Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: DP_HumanName

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-HumanName Version: 0.3.0
Draft as of 2025-06-23 Computable Name: DP_HumanName

A HumanName datatype, only text required, sets the lengths for text and key elements.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
... use S 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
... text 1..1 string Text representation of the full name
Max Length:250
... family S 0..1 string Family name (often called 'Surname')
Max Length:100
... prefix S 0..* string Parts that come before the name
Max Length:100
... suffix S 0..* string Parts that come after the name
Max Length:100
... period S 0..1 DP_Period_1 Time period when name was/is in use

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... use ?!SΣ 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
... text Σ 1..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
Max Length:250
... family SΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
Max Length:100
... prefix SΣ 0..* string Parts that come before the name
ele-1: All FHIR elements must have a @value or children
This repeating element order: Prefixes appear in the correct order for presenting the name
Max Length:100
... suffix SΣ 0..* string Parts that come after the name
ele-1: All FHIR elements must have a @value or children
This repeating element order: Suffixes appear in the correct order for presenting the name
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when name was/is in use
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... family SΣ 0..1 string Family name (often called 'Surname')
Max Length:100
... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Max Length:100
... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when name was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from HumanName

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
... use S 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
... text 1..1 string Text representation of the full name
Max Length:250
... family S 0..1 string Family name (often called 'Surname')
Max Length:100
... prefix S 0..* string Parts that come before the name
Max Length:100
... suffix S 0..* string Parts that come after the name
Max Length:100
... period S 0..1 DP_Period_1 Time period when name was/is in use

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... use ?!SΣ 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
... text Σ 1..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
Max Length:250
... family SΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
Max Length:100
... prefix SΣ 0..* string Parts that come before the name
ele-1: All FHIR elements must have a @value or children
This repeating element order: Prefixes appear in the correct order for presenting the name
Max Length:100
... suffix SΣ 0..* string Parts that come after the name
ele-1: All FHIR elements must have a @value or children
This repeating element order: Suffixes appear in the correct order for presenting the name
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when name was/is in use
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanName Name of a human - parts and usage
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ 0..1 DP_code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... family SΣ 0..1 string Family name (often called 'Surname')
Max Length:100
... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length:100
... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Max Length:100
... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Max Length:100
... period SΣ 0..1 DP_Period_1 Time period when name was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from HumanName

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron