Clinical Document Architecture V2.0.1
2.1.0-cibuild - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0-cibuild). This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: ObservationMedia (CDA Class)

Official URL: http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia Version: 2.1.0-cibuild
Active as of 2022-11-02 Computable Name: CDAR2.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:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1string
... @classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... @typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... @contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... @typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... @contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... @typeCode 1..1code
.... @inversionInd 0..1boolean
.... @contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... @negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... @typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 6 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1string
... @classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... @typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... @contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... @typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... @contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... @typeCode 1..1code
.... @inversionInd 0..1boolean
.... @contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... @negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... @typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationMedia 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1ED
... subject 0..1Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... observation 0..1Observation
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act
... reference 0..*Element
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ObservationMedia.classCoderequiredFixed Value: OBS
ObservationMedia.moodCoderequiredFixed Value: EVN
ObservationMedia.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ObservationMedia.subject.typeCoderequiredFixed Value: SBJ
ObservationMedia.subject.contextControlCoderequiredFixed Value: OP
ObservationMedia.subject.awarenessCodeextensibleTargetAwareness
ObservationMedia.informant.typeCoderequiredFixed Value: INF
ObservationMedia.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 6 elements

 

Other representations of profile: CSV, Excel