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

Logical Model: ObservationMedia (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia Version: 1.0.0
Active as of 2024-12-18 Responsible: HL7 Computable Name: ObservationMedia

A derivative of the RIM Observation class that represents multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type.

An XML attribute "ID" of type XML ID, is added to ObservationMedia within the CDA Schema. This attribute serves as the target of a renderMultiMedia reference (see renderMultiMedia). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).

The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation.

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
.. ObservationMedia 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)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ObservationMedia.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorObservationMedia.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ObservationMedia.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorObservationMedia.typeIdAn 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(3 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
.. ObservationMedia 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)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ObservationMedia.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorObservationMedia.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 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
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 ED
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ObservationMedia.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ObservationMedia.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
from this IG
ObservationMedia.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ObservationMedia.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorObservationMedia.typeIdAn 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(3 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel