This page is part of the HL7 Europe Laboratory Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Human Name Obligations

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.

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

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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
extension:fathersFamily	O	0..*	fathers-family	Portion of family name derived from father Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
extension:mothersFamily	O	0..*	mothers-family	Portion of family name derived from mother Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
given	O	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
HumanName		0..*	HumanNameEu	Name of a human - parts and usage
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 Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HumanName.use	required	NameUse

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

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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator 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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator 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
HumanName.use	required	NameUse

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

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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
extension:fathersFamily	O	0..*	fathers-family	Portion of family name derived from father Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
extension:mothersFamily	O	0..*	mothers-family	Portion of family name derived from mother Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
given	O	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HumanName		0..*	HumanNameEu	Name of a human - parts and usage
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 Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HumanName.use	required	NameUse

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

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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 Obligations Actor handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator populate LabReportCreator
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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator 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 handle LabReportRepos handle LabReportConsumer send LabReportRepos send LabReportCreator 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
HumanName.use	required	NameUse

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