Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: ADHA RegionOfInterest (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest Version: 1.0.0
Active as of 2024-08-29 Computable Name: au-RegionOfInterest

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

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

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA RegionOfInterest 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen Australian-adapted Specimen class
... performer 0..* Performer2 Australian-adapted Performer class
... author 0..* Author Australian-adapted Author class
... informant 0..* Informant Australian-adapted Informant class
... participant 0..* Participant2 Australian-adapted Participant2 class
... entryRelationship 0..* EntryRelationship Australian-adapted EntryRelationship class
... reference 0..* Reference Australian-adapted Reference class
... precondition 0..* Precondition Australian-adapted Precondition class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel