Clinical Document Architecture with Australian Schema
1.0.1 - active
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.1 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/ParticipantRole | Version: 1.0.1 | |||
| Active as of 2025-11-09 | Maturity Level: 1 | Responsible: HL7 | Computable Name: ParticipantRole | |
ParticipantRole (CDA Class)
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:   |
|---|---|---|---|---|
  ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
  @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: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
 (Choice of one) |
0..1 | |||
 playingDevice |
0..1 | Device | ||
 playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| (Choice of one) |
0..1 | |||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
| @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: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| (Choice of one) |
0..1 | |||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
This structure is derived from InfrastructureRoot
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
| @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: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| (Choice of one) |
0..1 | |||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| (Choice of one) |
0..1 | |||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice |
| @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: CDARoleClassRoot (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| (Choice of one) |
0..1 | |||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦1.0.1 | This IG |
| ParticipantRole.code | Base | example | CDARoleCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
This structure is derived from InfrastructureRoot
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.1 based on FHIR 5.0.0. Generated 2025-11-09
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
