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

Official URL: http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest Version: 2.1.0-cibuild
Active as of 2022-11-02 Computable Name: CDAR2.RegionOfInterest

A derivative of the RIM Observation class that represents a region of interest on an image, using an overlay shape. RegionOfInterest is used to make reference to specific regions in images, e.g., to specify the site of a physical finding by “circling” a region in a schematic picture of a human body. The units of the coordinate values in RegionOfInterest.value are in pixels, expressed as a list of integers. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down. The relationship between a RegionOfInterest and its referenced ObservationMedia or ExternalObservation is specified by traversing the entryRelationship or reference class, respectively, where typeCode equals “SUBJ”. A RegionOfInterest must reference exactly one ObservationMedia or one ExternalObservation. If the RegionOfInterest is the target of a reference, then it shall only reference an ObservationMedia and not an ExternalObservation. An XML attribute "ID" of type XML ID, is added to RegionOfInterest 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).

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
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1string
... @classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... @typeCode 1..1code
.... @inversionInd 0..1boolean
.... @contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... @negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.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())
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... 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
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.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()
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from Base

Summary

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

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1string
... @classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... @typeCode 1..1code
.... @inversionInd 0..1boolean
.... @contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... @negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.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())
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseBase for all types and resources
... ID 0..1string
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... code 1..1CS
... value 1..*INT
... 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 C0..*Elementroi-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... 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
.... (Choice of one) 1..1
..... 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
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
RegionOfInterest.subject.typeCoderequiredFixed Value: SBJ
RegionOfInterest.subject.contextControlCoderequiredFixed Value: OP
RegionOfInterest.subject.awarenessCodeextensibleTargetAwareness
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.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()
roi-er-1errorRegionOfInterest.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from Base

Summary

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

 

Other representations of profile: CSV, Excel