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-Participant1 | Version: 1.0.0 | |||
| Active as of 2024-12-18 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA 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 | Conformance | ValueSet / Code | URI |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
 @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 | Conformance | ValueSet / Code | URI |
| Participant1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Participant1.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Conformance | ValueSet / Code | URI |
| Participant1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA 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 | Conformance | ValueSet / Code | URI |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Conformance | ValueSet / Code | URI |
| Participant1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Participant1.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Participant1 |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Participant1 class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Conformance | ValueSet / Code | URI |
| Participant1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Participant1.typeCode | required | ParticipationTypehttp://terminology.hl7.org/ValueSet/v3-ParticipationType | |
| Participant1.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControlfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
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
