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

A human being.

This class can be used to represent either a single individual, a group of individuals or a kind of individual based on the values of Entity.determinerCode and Entity.quantity.

Usage:

• Use this Logical Model Profile: AssignedAuthor (CDA Class), AssignedEntity (CDA Class), AssociatedEntity (CDA Class), Guardian (CDA Class)... Show 3 more, IntendedRecipient (CDA Class), MaintainedEntity (CDA Class) and RelatedEntity (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
Person		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)
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@classCode		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Name	Flags	Card.	Type	Description & Constraints
Person		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
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@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		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Person.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Person		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
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@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		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Person.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Person		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)
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@classCode		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Person		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
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@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		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Person.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Person		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
@classCode		0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@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		1..1	cs	Fixed Value: PRS
@determinerCode		0..1	cs	Fixed Value: INSTANCE
code		1..1	CE	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Person.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Person.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Person.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Person.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel