HL7 Europe Laboratory Report
0.2.0-ci - ci-build 150

HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions

Data Type Profile: Human Name Obligations

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/HumanName-obl-eu-lab Version: 0.2.0-ci
Standards status: Informative Maturity Level: 0 Computable Name: HumanNameEuObligations

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.

This structure is derived from HumanNameEu

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanNameEu Name of a human - parts and usage
... family O 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... Slices for extension Content/Rules for all slices
..... extension:fathersFamily O 0..* FathersFamily(5.1.0) Portion of family name derived from father
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... extension:mothersFamily O 0..* MothersFamily(5.1.0) Portion of family name derived from mother
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
... given O 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... Slices for extension Content/Rules for all slices
..... 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
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... 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
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
... 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate

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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

... family OΣ 0..1 string Family name (often called 'Surname')
Example spanish name: Valero Iglesias
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... fathersFamily O 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... mothersFamily O 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
.... 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
... 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|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 HumanNameEu

Summary

Maturity: 0

Differential View

This structure is derived from HumanNameEu

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..* HumanNameEu Name of a human - parts and usage
... family O 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... Slices for extension Content/Rules for all slices
..... extension:fathersFamily O 0..* FathersFamily(5.1.0) Portion of family name derived from father
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... extension:mothersFamily O 0..* MothersFamily(5.1.0) Portion of family name derived from mother
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
... given O 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... Slices for extension Content/Rules for all slices
..... 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
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... 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
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
... 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

... family OΣ 0..1 string Family name (often called 'Surname')
Example spanish name: Valero Iglesias
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... fathersFamily O 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
..... mothersFamily O 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
ObligationsActor
SHALL:handle
SHALL:handle
MAY:able-to-populate
.... 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
ObligationsActor
SHALL:handle
SHALL:handle
SHALL:able-to-populate
... 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|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 HumanNameEu

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron