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

Logical Model: ADHA Participant1 (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant1 Version: 1.0.0
Active as of 2024-11-22 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

ParticipationType Value Set

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... associatedEntity 1..1 au-AssociatedEntity Australian-adapted AssociatedEntity class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... associatedEntity 1..1 au-AssociatedEntity Australian-adapted AssociatedEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 0..1 II
.... @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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Participant1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG

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:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... associatedEntity 1..1 au-AssociatedEntity Australian-adapted AssociatedEntity class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... associatedEntity 1..1 au-AssociatedEntity Australian-adapted AssociatedEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 0..1 II
.... @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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Participant1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Participant1.typeCoderequiredParticipationType
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG

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:

 

Other representations of profile: CSV, Excel