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://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName | Version: 1.0.0 | |||
| Active as of 2024-11-22 | Computable Name: au-EntityName | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA Entity Name dataType.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ANY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @use |
0..* | cs | Binding: Entity Name Use (required) | |
  item |
C | 0..* | 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 |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @use |
0..* | cs | Binding: Entity Name Use (required) | |
| item |
C | 0..* | 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 |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @use |
0..* | cs | Binding: Entity Name Use (required) | |
| item |
C | 0..* | 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 |
| EN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
This structure is derived from ANY
Differential View
This structure is derived from ANY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @use |
0..* | cs | Binding: Entity Name Use (required) | |
| item |
C | 0..* | 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 |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @use |
0..* | cs | Binding: Entity Name Use (required) | |
| item |
C | 0..* | 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 |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EN |
1..* | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International EntityName (EN) dataType Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @use |
0..* | cs | Binding: Entity Name Use (required) | |
| item |
C | 0..* | 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 |
| EN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EN.use | required | entitynameusehttp://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameusefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| EN-1 | error | EN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 |
This structure is derived from ANY
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-22
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
