Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: PN: PersonName (V3 Data Type)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/PN Version: 1.0.0
Active as of 2024-08-29 Responsible: HL7 Computable Name: PN

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

Usage:

Formal Views of Profile Content

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

This structure is derived from EN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... item 1..* Base

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
EN-1: Can only have only one of the possible item elements in each choice

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorPN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @use 0..* cs Binding: CDAEntityNameUse (required)
... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
EN-1: Can only have only one of the possible item elements in each choice
.... (Choice of one) 1..1
..... delimiter 0..* ENXP
..... family 0..* ENXP
..... given 0..* ENXP
..... prefix 0..* ENXP
..... suffix 0..* ENXP
..... xmlText 0..1 st Allows for mixed text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PN.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorPN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()

This structure is derived from EN

Summary

Mandatory: 1 element

Differential View

This structure is derived from EN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... item 1..* Base

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
EN-1: Can only have only one of the possible item elements in each choice

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorPN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C 1..* EN XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @use, item, validTime
Base for all types and resources
Logical Container: ADHA ClinicalDocument (CDA Class)
pn-no-ls: No PN name part may have a qualifier of LS.
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @use 0..* cs Binding: CDAEntityNameUse (required)
... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
EN-1: Can only have only one of the possible item elements in each choice
.... (Choice of one) 1..1
..... delimiter 0..* ENXP
..... family 0..* ENXP
..... given 0..* ENXP
..... prefix 0..* ENXP
..... suffix 0..* ENXP
..... xmlText 0..1 st Allows for mixed text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PN.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorPN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-lserrorPNNo PN name part may have a qualifier of LS.
: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()

This structure is derived from EN

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel