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/Guardian | Version: 1.0.0 | |||
| Active as of 2024-12-18 | Responsible: HL7 | Computable Name: Guardian | ||
A patient's guardian is a person or organization in the role of guardian (Guardian class). The entity playing the role of guardian is a person (Person class) or organization (Organization class). The entity scoping the role is the patient (Patient class).
Where a guardian is not explicitly stated, the value should default to local business practice (e.g. the patient makes their own health care decisions unless incapacitated in which case healthcare decisions are made by the patient's spouse).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
  @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
 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) |
1..1 | |||
  guardianPerson |
0..1 | Person | ||
 guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
| @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 | ||
| @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
| 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) |
1..1 | |||
| guardianPerson |
0..1 | Person | ||
| guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Guardian.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
| @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 | ||
| @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
| 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) |
1..1 | |||
| guardianPerson |
0..1 | Person | ||
| guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Guardian.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
This structure is derived from InfrastructureRoot
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
| @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
| 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) |
1..1 | |||
| guardianPerson |
0..1 | Person | ||
| guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
| @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 | ||
| @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
| 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) |
1..1 | |||
| guardianPerson |
0..1 | Person | ||
| guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Guardian.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Guardian |
C | 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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present) |
| @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 | ||
| @classCode |
0..1 | cs | Binding: RoleClassAgent (required) Fixed Value: GUARD | |
| 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) |
1..1 | |||
| guardianPerson |
0..1 | Person | ||
| guardianOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Guardian.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Guardian.classCode | required | Fixed Value: GUARDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAgent | |
| Guardian.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Guardian.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| guardian-choice | error | Guardian | guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson | guardianOrganization).count() = 1 |
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
