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://hl7.org/cda/stds/core/StructureDefinition/Authenticator | Version: 1.0.0 | |||
| Active as of 2024-12-18 | Responsible: HL7 | Computable Name: Authenticator | ||
Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it. A clinical document can have zero to many authenticators. 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. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
 time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| signature | warning | Authenticator.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 |
|---|---|---|---|---|
| Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Authenticator.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| signature | warning | Authenticator.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 |
|---|---|---|---|---|
| Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Authenticator.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| signature | warning | Authenticator.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
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| signature | warning | Authenticator.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' |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Authenticator.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| signature | warning | Authenticator.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 |
|---|---|---|---|---|
| Authenticator |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
1..1 | TS | ||
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) signature: 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'. |
| 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 | Conformance | ValueSet / Code | URI |
| Authenticator.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Authenticator.typeCode | required | Fixed Value: AUTHENhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationTypefrom this IG | |
| Authenticator.signatureCode | required | CDASignatureCodehttp://hl7.org/cda/stds/core/ValueSet/CDASignatureCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Authenticator.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| signature | warning | Authenticator.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
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
