Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/PN | Version: 1.0.0 | |||
| Active as of 2024-12-18 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EN
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| pn-no-ls | error | PN | No 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| validTime |
0..1 | IVL_TS | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| PN.use | required | CDAEntityNameUsehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUsefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| validTime |
0..1 | IVL_TS | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| PN.use | required | CDAEntityNameUsehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUsefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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
Differential View
This structure is derived from EN
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| pn-no-ls | error | PN | No 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| validTime |
0..1 | IVL_TS | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| PN.use | required | CDAEntityNameUsehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUsefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| validTime |
0..1 | IVL_TS | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| PN.use | required | CDAEntityNameUsehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUsefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
