Clinical Document Architecture with Australian Schema
1.0.1 - active
Clinical Document Architecture with Australian Schema - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant1 | Version: 1.0.1 | |||
| Active as of 2025-10-10 | Maturity Level: 1 | Computable Name: au-Participant1 | ||
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 Participant1 class.
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
The terminology binding on the au-Participant1 @typeCode attribute has been changed to use the v3-ParticipationType valueSet rather than the valueSet as used in HL7 International CDA Participant1 class. This is due to the attribute value of PART, which is mandated in many of the My Health Record CDA implementations.
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:   |
|---|---|---|---|---|
  Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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 | ||
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Participant1.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: |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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 | ||
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Participant1.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(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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 | ||
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Participant1.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: |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Australian adaptation of the HL7 International CDA Participant1 class Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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 | ||
| @typeCode |
1..1 | cs | Binding: ParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
0..1 | IVL_TS | ||
| associatedEntity |
1..1 | au-AssociatedEntity | Australian-adapted AssociatedEntity class | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Participant1.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Participant1.typeCode | Base | required | ParticipationType | 📦2.0.0 | THO v5.2 |
| Participant1.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Participant1.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(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.1 based on FHIR 5.0.0. Generated 2025-10-10
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
