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/ParentDocument | Version: 1.0.0 | |||
| Active as of 2025-08-28 | Maturity Level: 1 | Responsible: HL7 | Computable Name: ParentDocument | |
The ParentDocument represents the source of a document revision, addenda, or transformation. ParentDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the parent document. It is not to be used to embed the related document, and thus ParentDocument.text.BIN is precluded from use.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 realmCode |
0..* | CS | ||
 typeId |
C | 0..1 | II | Constraints: II-1 |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | ParentDocument.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | ParentDocument.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | ParentDocument.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParentDocument |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text |
0..1 | ED | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParentDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| ParentDocument.classCode | required | Fixed Value: DOCCLINhttp://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument | |
| ParentDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodFrom this IG | |
| ParentDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | ParentDocument.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2025-08-28
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
