Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: NlcoreNameInformation | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
A person’s official name information, including given names, last name and possibly the partner’s last name.
A derived profile from zib-NameInformation to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
For the entire zib, the complementary profile nl-core-NameInformation.GivenName should be used. Both profiles can be added in a slice with the discriminator set to value/use.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ZibNameInformation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HumanName | C | 0..* | ZibNameInformation | NameInformation |
  nameUsage | 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. | |
   extension | 0..0 | |||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
 value[x] | 1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
 use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| HumanName.extension:nameUsage.value[x] | required | HumanNameAssemblyOrder |
| HumanName.use | required | Pattern: official |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| zib-NameInformation-1 | error | HumanName | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | HumanName | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | C | 0..* | ZibNameInformation | NameInformation |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| nameUsage | 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. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
| value[x] | 1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 0..1 | string | Family name (often called 'Surname') |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| prefix | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |
| value[x] | 1..1 | string | Prefix | |
| lastName | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |
| value[x] | 1..1 | string | LastName | |
| partnerPrefix | 0..1 | string | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |
| value[x] | 1..1 | string | PartnerPrefix | |
| partnerLastName | 0..1 | string | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |
| value[x] | 1..1 | string | PartnerLastName | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| given | Σ | 0..* | string | FirstName / Initial 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| givenOrInitial | 1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 | Titles This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Titles 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| HumanName.extension:nameUsage.value[x] | required | HumanNameAssemblyOrder |
| HumanName.use | required | Pattern: official |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| zib-NameInformation-1 | error | HumanName | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | HumanName | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
This structure is derived from ZibNameInformation
Differential View
This structure is derived from ZibNameInformation
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | C | 0..* | ZibNameInformation | NameInformation |
| nameUsage | 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. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
| value[x] | 1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| HumanName.extension:nameUsage.value[x] | required | HumanNameAssemblyOrder |
| HumanName.use | required | Pattern: official |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| zib-NameInformation-1 | error | HumanName | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | HumanName | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | C | 0..* | ZibNameInformation | NameInformation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| nameUsage | 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. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
| value[x] | 1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 0..1 | string | Family name (often called 'Surname') |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| prefix | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |
| value[x] | 1..1 | string | Prefix | |
| lastName | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |
| value[x] | 1..1 | string | LastName | |
| partnerPrefix | 0..1 | string | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |
| value[x] | 1..1 | string | PartnerPrefix | |
| partnerLastName | 0..1 | string | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |
| value[x] | 1..1 | string | PartnerLastName | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| given | Σ | 0..* | string | FirstName / Initial 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| givenOrInitial | 1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 | Titles This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Titles 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| HumanName.extension:nameUsage.value[x] | required | HumanNameAssemblyOrder |
| HumanName.use | required | Pattern: official |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| zib-NameInformation-1 | error | HumanName | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | HumanName | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
This structure is derived from ZibNameInformation
Other representations of profile: CSV, Excel, Schematron