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/LegalAuthenticator | Version: 1.0.1 | |||
| Active as of 2025-10-09 | Maturity Level: 1 | Responsible: HL7 | Computable Name: LegalAuthenticator | |
Represents a participant who has legally authenticated the document. The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated). While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.
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:   |
|---|---|---|---|---|
  LegalAuthenticator |
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) | |
  @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | LegalAuthenticator.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| LegalAuthenticator |
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) | |
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| LegalAuthenticator |
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) | |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | LegalAuthenticator.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(3 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| LegalAuthenticator |
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) | |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | LegalAuthenticator.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| LegalAuthenticator |
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) | |
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| LegalAuthenticator |
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) | |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| LegalAuthenticator.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| LegalAuthenticator.typeCode | Base | required | CDAParticipationType | 📦1.0.1 | This IG |
| LegalAuthenticator.contextControlCode | Base | required | CDAContextControl | 📦1.0.1 | This IG |
| LegalAuthenticator.signatureCode | Base | required | CDASignatureCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | LegalAuthenticator.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| signature | warning | LegalAuthenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(3 nested mandatory elements)
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.1 based on FHIR 5.0.0. Generated 2025-10-09
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
