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

A bounded physical place or site, including any contained structures.

Place may be natural or man-made. The geographic position of a place may or may not be constant. Places may be work facilities (where relevant acts occur), homes (where people live) or offices (where people work). Places may contain sub-places (floor, room, booth, bed). Places may also be sites that are investigated in the context of health care, social work, public health administration (e.g., buildings, picnic grounds, day care centers, prisons, counties, states, and other focuses of epidemiological events).

Examples: A field, lake, city, county, state, country, lot (land), building, pipeline, power line, playground, ship, truck

Usages:

• Use this Logical Model: Birthplace (CDA Class) and HealthCareFacility (CDA Class)

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
Place		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Place.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

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

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Place		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: ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Place		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Place.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

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

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Place		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Place.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

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

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Place		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: ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Place		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassPlace (required) Fixed Value: PLC
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
name		0..1	EN
addr		0..1	AD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Place.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Place.classCode	required	Fixed Value: PLC http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
Place.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

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

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

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

Maturity: 1

Other representations of profile: CSV, Excel