Standard Health Record FHIR Implementation Guide

SHR HumanName Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-HumanName

A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.).

This profile builds on HumanName.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (1 nested mandatory element)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.HumanName maps to HumanName:
  string maps to text
  HumanNamePrefix maps to prefix
  GivenName maps to given
  FamilyName maps to family
  HumanNameSuffix maps to suffix
  Purpose maps to use
  EffectiveTimePeriod maps to period

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName SHR HumanName Profile
... text 1..1
... prefix 0..1

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*SHR HumanName Profile
... id 0..1stringxml:id (or equivalent in JSON)
... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
... text Σ1..1stringText representation of the full name
... family Σ0..1stringFamily name (often called 'Surname')
... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefix Σ0..1stringParts that come before the name
... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.HumanName maps to HumanName:
  string maps to text
  HumanNamePrefix maps to prefix
  GivenName maps to given
  FamilyName maps to family
  HumanNameSuffix maps to suffix
  Purpose maps to use
  EffectiveTimePeriod maps to period

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName SHR HumanName Profile
... text 1..1
... prefix 0..1

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName I0..*SHR HumanName Profile
... id 0..1stringxml:id (or equivalent in JSON)
... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
... text Σ1..1stringText representation of the full name
... family Σ0..1stringFamily name (often called 'Surname')
... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... prefix Σ0..1stringParts that come before the name
... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
HumanName.useNameUserequiredNameUse

 

Constraints

IdPathDetailsRequirements
ele-1HumanNameAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())