HL7 Europe Laboratory Report
0.1.1 - trial-use 150

Publication Build: This will be filled in by the publication tooling

## Data Type Profile: Human Name Obligations

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/HumanName-obl-eu-lab | Version: 0.1.1
Standards status: Informative | Maturity Level: 0 | Computable Name: HumanNameEuObligations
Other Identifiers: OID:2.16.840.1.113883.2.51.22.1.42.8
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile defines obligations for an human Patient name in FHIR for the purpose of this guide.

Usage:

- This DataType Constraint is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | 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
family | O Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:fathersFamily | O | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
given | O Σ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HumanName.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard

#### Constraints

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() |

This structure is derived from HumanNameEu

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | Name of a human - parts and usage
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:fathersFamily | O | 0..* | FathersFamily(5.2.0) | Portion of family name derived from father
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | MothersFamily(5.2.0) | Portion of family name derived from mother
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | 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 | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | O Σ | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:fathersFamily | O | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
value |  | 0..1 | string | Primitive value for string Max Length:1048576
given | O Σ | 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 Example spanish name: Borja
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HumanName.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard

#### Constraints

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() |

This structure is derived from HumanNameEu

Summary

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | 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
family | O Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:fathersFamily | O | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
given | O Σ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HumanName.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard

#### Constraints

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() |

Differential View

This structure is derived from HumanNameEu

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | Name of a human - parts and usage
family | O | 0..1 | string | Family name (often called 'Surname')
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:fathersFamily | O | 0..* | FathersFamily(5.2.0) | Portion of family name derived from father
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | MothersFamily(5.2.0) | Portion of family name derived from mother
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
given | O | 0..* | string | Given names (not always 'first'). Includes middle names
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HumanName |  | 0..* | HumanNameEu | 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 | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | O Σ | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:fathersFamily | O | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
extension:mothersFamily | O | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
MAY:able-to-populate | LabReportCreator
value |  | 0..1 | string | Primitive value for string Max Length:1048576
given | O Σ | 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 Example spanish name: Borja
Obligations | Actor
SHALL:handle | LabReportRepos
SHALL:handle | LabReportConsumer
SHALL:able-to-populate | LabReportCreator
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HumanName.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard

#### Constraints

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() |

This structure is derived from HumanNameEu

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron