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: ADHA PatientRole (CDA Class)

Australian adaptation of the HL7 International CDA PatientRole 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

Usage:

• Use this Logical Model Profile: ADHA RecordTarget (CDA Class)

Formal Views of Profile Content

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

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

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole 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
templateId		0..*	II
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• ADHA Patient (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-Patient)
• ADHA Organization (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PatientRole		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA PatientRole 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
templateId		0..*	II
@classCode		0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
addr		0..*	AD	Australian-adapted PostalAddress datatype
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
patient		0..1	au-Patient	Australian-adapted Patient class
providerOrganization		0..1	au-Organization	Australian-adapted ProviderOrganization class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
PatientRole.classCode	required	Fixed Value: PAT http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• ADHA Patient (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-Patient)
• ADHA Organization (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization)

Other representations of profile: CSV, Excel