Clinical Document Architecture with Australian Schema

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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: II: InstanceIdentifier (V3 Data Type)

An identifier that uniquely identifies a thing or object. Examples are object identifier for HL7 RIM objects, medical record number, order id, service catalog item id, Vehicle Identification Number (VIN), etc. Instance identifiers are defined based on ISO object identifiers.

Usages:

• Use this Logical Model: Act (CDA Class), AlternateIdentification (CDA Class), AssignedAuthor (CDA Class), AssignedEntity (CDA Class)... Show 79 more, AssociatedEntity (CDA Class), ClinicalDocument (CDA Class), Consent (CDA Class), Criterion (CDA Class), CustodianOrganization (CDA Class), EncompassingEncounter (CDA Class), Encounter (CDA Class), Entity (CDA Class), ExternalAct (CDA Class), ExternalDocument (CDA Class), ExternalObservation (CDA Class), ExternalProcedure (CDA Class), Guardian (CDA Class), HealthCareFacility (CDA Class), InFulfillmentOf1 (CDA Class), InfrastructureRoot (Base Type for all CDA Classes), IntendedRecipient (CDA Class), ManufacturedProduct (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class), ObservationRange (CDA Class), Order (CDA Class), Organization (CDA Class), OrganizationPartOf (CDA Class), Organizer (CDA Class), ParentDocument (CDA Class), ParticipantRole (CDA Class), Patient (CDA Class), PatientRole (CDA Class), Agency extension PolicyOrAccount, PreconditionBase (CDA Class), Procedure (CDA Class), RegionOfInterest (CDA Class), RelatedSubject (CDA Class), Section (CDA Class), ServiceEvent (CDA Class), SpecimenRole (CDA Class), SubjectPerson (CDA Class), SubstanceAdministration (CDA Class), Supply (CDA Class), ADHA extension asIngredient, ADHA extension asPersonalRelationship, ADHA Act (CDA Class), ADHA AssignedAuthor (CDA Class), ADHA AssignedEntity (CDA Class), ADHA AssociatedEntity (CDA Class), ADHA ClinicalDocument (CDA Class), ADHA CustodianOrganization (CDA Class), ADHA EncompassingEncounter (CDA Class), ADHA Encounter (CDA Class), ADHA Entity (CDA Class), ADHA ExternalAct (CDA Class), ADHA ExternalDocument (CDA Class), ADHA HealthCareFacility (CDA Class), ADHA IntendedRecipient (CDA Class), ADHA ManufacturedProduct (CDA Class), ADHA Observation (CDA Class), ADHA ObservationMedia (CDA Class), ADHA ObservationRange (CDA Class), ADHA Order (CDA Class), ADHA Organization (CDA Class), ADHA OrganizationPartOf (CDA Class), ADHA Organizer (CDA Class), ADHA ParentDocument (CDA Class), ADHA Patient (CDA Class), ADHA PatientRole (CDA Class), ADHA Procedure (CDA Class), ADHA RegionOfInterest (CDA Class), ADHA Section (CDA Class), SpecimenRole (CDA Class), ADHA SubstanceAdministration (CDA Class), ADHA Supply (CDA Class), ADHA extension Container, ADHA extension controlAct, ADHA extension employerOrganization, ADHA extension entitlement , ADHA extension ingredientManufacturedMaterial, ADHA extension personalRelationship and Agency extension policy

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Maturity: 1

Other representations of profile: CSV, Excel