Clinical Document Architecture V2.0.1
2.1.0 - 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). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: RegionOfInterest (CDA Class)

Defining URL:http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
Version:2.1.0
Name:CDAR2.RegionOfInterest
Title:RegionOfInterest (CDA Class)
Status:Active as of 2020-11-19T18:06:12+00:00
Definition:

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 <renderMultimedia> 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).

Publisher:Health Level 7
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest

Formal Views of Profile Content

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

This structure is derived from Base

Summary

Mandatory: 0 element (22 nested mandatory elements)
Fixed Value: 10 elements

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... ID 0..1string
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*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..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... ID 0..1string
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*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..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element (22 nested mandatory elements)
Fixed Value: 10 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... ID 0..1string
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*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..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1
... classCode 1..1codeBinding: ActClassROI (required)
Fixed Value: ROIOVL
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... ID 0..1string
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... 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..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*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..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

 

Other representations of profile: Schematron

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.specimen.typeCoderequiredFixed Value: SPC
RegionOfInterest.performer.typeCoderequiredFixed Value: PRF
RegionOfInterest.performer.modeCodeextensibleParticipationMode
RegionOfInterest.informant.typeCoderequiredFixed Value: INF
RegionOfInterest.informant.contextControlCoderequiredFixed Value: OP
RegionOfInterest.participant.typeCoderequiredParticipationType
RegionOfInterest.participant.contextControlCoderequiredFixed Value: OP
RegionOfInterest.participant.awarenessCodeextensibleTargetAwareness
RegionOfInterest.precondition.typeCoderequiredFixed Value: PRCN

Constraints

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