Shared Health Specification and Guide Version 5.0

 

3.55 StructureDefinition: Shared Health HumanName

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-humanname

3.55.2 Formal Views of Profile Content

Download Excel representation

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

>

This structure is derived from HumanName

NameCard.TypeConstraints and Usage
.  HumanName 0..*HumanNameDefinition:
A human's name with the ability to identify parts and usage.


Comments:
This data type is used to support both Practitioner names and Patient names. These name values are used for SAML validation (Practitioner) and eFax generation, and possibly patient matching algorithms.



Conformance Rule: For the purpose of presentation, the data elements will be organized as Prefix + Given1 + Given2 + Family + Suffix.

..  use 1..1codeBinding: SharedNameUse (20190415) (required)
Definition:
Identifies the purpose for this name.


Comments:
This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

..  family 1..1stringDefinition:
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.


Comments:
Conformance rule: Family is not to include professional designations

..  given 1..2stringDefinition:
Given name.


Comments:
Conformance Rule: Given name(s) is not to include profession designations

..  prefix 0..1stringDefinition:
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.


Comments:
Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

..  suffix 0..1stringDefinition:
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.


Comments:
Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

This structure is derived from HumanName

Summary

Mandatory: 3 elements
Must-Support: 5 elements

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*HumanNameName of a human - parts and usage
... use S1..1codeofficial | usual
Binding: SharedNameUse (20190415) (required)
... family S1..1stringFamily name (often called 'Surname')
... given S1..2stringGiven names (not always 'first'). Includes middle names
... prefix S0..1stringParts that come before the name
... suffix S0..1stringParts that come after the name

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*HumanNameName of a human - parts and usage
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!SΣ1..1codeofficial | usual
Binding: SharedNameUse (20190415) (required)
... text Σ0..1stringText representation of the full name
... family SΣ1..1stringFamily name (often called 'Surname')
... given SΣ1..2stringGiven names (not always 'first'). Includes middle names
... prefix SΣ0..1stringParts that come before the name
... suffix SΣ0..1stringParts that come after the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

Grid View

This structure is derived from HumanName

NameCard.TypeConstraints and Usage
.  HumanName 0..*HumanNameDefinition:
A human's name with the ability to identify parts and usage.


Comments:
This data type is used to support both Practitioner names and Patient names. These name values are used for SAML validation (Practitioner) and eFax generation, and possibly patient matching algorithms.



Conformance Rule: For the purpose of presentation, the data elements will be organized as Prefix + Given1 + Given2 + Family + Suffix.

..  use 1..1codeBinding: SharedNameUse (20190415) (required)
Definition:
Identifies the purpose for this name.


Comments:
This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

..  family 1..1stringDefinition:
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.


Comments:
Conformance rule: Family is not to include professional designations

..  given 1..2stringDefinition:
Given name.


Comments:
Conformance Rule: Given name(s) is not to include profession designations

..  prefix 0..1stringDefinition:
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.


Comments:
Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

..  suffix 0..1stringDefinition:
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.


Comments:
Conformance Rule: Prefix or Suffix must be used for Practitioner to represent the appropriate professional designation.

This structure is derived from HumanName

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Differential View

This structure is derived from HumanName

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*HumanNameName of a human - parts and usage
... use S1..1codeofficial | usual
Binding: SharedNameUse (20190415) (required)
... family S1..1stringFamily name (often called 'Surname')
... given S1..2stringGiven names (not always 'first'). Includes middle names
... prefix S0..1stringParts that come before the name
... suffix S0..1stringParts that come after the name

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HumanName 0..*HumanNameName of a human - parts and usage
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!SΣ1..1codeofficial | usual
Binding: SharedNameUse (20190415) (required)
... text Σ0..1stringText representation of the full name
... family SΣ1..1stringFamily name (often called 'Surname')
... given SΣ1..2stringGiven names (not always 'first'). Includes middle names
... prefix SΣ0..1stringParts that come before the name
... suffix SΣ0..1stringParts that come after the name
... period Σ0..1PeriodTime period when name was/is in use

doco Documentation for this format

 

Other representations of profile: Schematron

3.55.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
HumanName.userequiredSharedNameUse

3.55.4 Constraints

Constraints

IdPathDetailsRequirements