Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: nl-core-humanname

Official URL: http://fhir.nl/fhir/StructureDefinition/nl-core-humanname Version: 1.3.15
Active as of 2024-04-09 Computable Name: nl-core-humanname

Copyright/Legal: CC0

Base datatype for HumanName Type with additions for Dutch realm names. Dutch names break down the family into maximum of 4 parts that are important to know separately in some if not most use cases.

Name information is used to identify and address person.

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 C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected
Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

... text 0..1 string Text representation of the full name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... valueString:valueString 0..1 string Value of extension
... given 0..* string Given
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... valueCode:valueCode 0..1 code Value of extension

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

... family Σ 0..1 string Surname
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
..... valueString:valueString 0..1 string Value of extension
... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
..... valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
HumanName.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


... text Σ 0..1 string Text representation of the full name
... family Σ 0..1 string Surname
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
..... valueString:valueString 0..1 string Value of extension
.... value 0..1 string Primitive value for string
Max Length: 1048576
... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
..... valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type

.... value 0..1 string Primitive value for string
Max Length: 1048576
... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ 0..1 Period 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
from the FHIR Standard
HumanName.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Differential View

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected
Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

... text 0..1 string Text representation of the full name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... valueString:valueString 0..1 string Value of extension
... given 0..* string Given
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... valueCode:valueCode 0..1 code Value of extension

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

... family Σ 0..1 string Surname
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
..... valueString:valueString 0..1 string Value of extension
... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
..... valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HumanName.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
HumanName.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName C 0..* HumanName Name of a human - parts and usage
nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected
nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... humannameAssemblyOrder 0..* code Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


... text Σ 0..1 string Text representation of the full name
... family Σ 0..1 string Surname
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... humannameOwnPrefix 0..1 (Complex) PrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannameOwnName 0..1 (Complex) OwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerPrefix 0..1 (Complex) PrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
..... valueString:valueString 0..1 string Value of extension
.... humannamePartnerName 0..1 (Complex) LastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
..... valueString:valueString 0..1 string Value of extension
.... value 0..1 string Primitive value for string
Max Length: 1048576
... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
..... valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type

.... value 0..1 string Primitive value for string
Max Length: 1048576
... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ 0..1 Period 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
from the FHIR Standard
HumanName.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorHumanNameif you specify a prefix for an own name then an own name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
nl-core-humanname-2errorHumanNameif you specify a voorvoegsel for a partner name then a partner name is also expected
: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

 

Other representations of profile: CSV, Excel, Schematron