This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.6.2.8 | Version: 2.1.0-draft1 | |||
Active as of 2023-01-16 | Computable Name: SOPInstanceObservation | |||
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.6.2.8 |
A SOP Instance Observation contains the DICOM Service Object Pair (SOP) Instance information for referenced DICOM composite objects. The SOP Instance act class is used to reference both image and non-image DICOM instances. The text attribute contains the DICOM WADO reference.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: DGIMG | |
moodCode | 1..1 | code | Required Pattern: EVN | |
id | 1..* | II | The @root contains an OID representing the DICOM SOP Instance UID | |
code | 1..1 | CD | ||
code | C | 1..1 | string | 81-19226: @code is an OID for a valid SOP class name UID (CONF:81-19226). |
codeSystem | 1..1 | string | Required Pattern: 1.2.840.10008.2.6.1 | |
text | 0..1 | ED | ||
mediaType | 1..1 | code | Required Pattern: application/dicom | |
reference | C | 1..1 | TEL | 81-9249: **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). |
effectiveTime | 0..1 | IVL_TS | ||
value | 1..1 | dateTime | ||
low | 0..0 | |||
high | 0..0 | |||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by value:typeCode | |
entryRelationship:subject | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
entryRelationship:purposeofReferenceObservation | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | PurposeofReferenceObservation | Base for all types and resources | |
entryRelationship:referencedFramesObservation | C | 0..* | Element | 81-9263: This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). |
typeCode | 1..1 | code | Required Pattern: COMP | |
observation | 1..1 | ReferencedFramesObservation | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | Base for all types and resources | |
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: DGIMG | |
moodCode | 1..1 | code | Required Pattern: EVN | |
id | 1..* | II | The @root contains an OID representing the DICOM SOP Instance UID | |
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | C | 1..1 | string | 81-19226: @code is an OID for a valid SOP class name UID (CONF:81-19226). |
codeSystem | 1..1 | string | Required Pattern: 1.2.840.10008.2.6.1 | |
text | 0..1 | ED | ||
mediaType | 1..1 | code | Required Pattern: application/dicom | |
reference | C | 1..1 | TEL | 81-9249: **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). |
effectiveTime | 0..1 | IVL_TS | ||
value | 1..1 | dateTime | ||
Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by value:typeCode |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:subject | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
contextConductionInd | 1..1 | boolean | ||
entryRelationship:purposeofReferenceObservation | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: RSON | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | PurposeofReferenceObservation | Base for all types and resources | |
entryRelationship:referencedFramesObservation | C | 0..* | Element | 81-9263: This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). |
typeCode | 1..1 | code | Required Pattern: COMP | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | ReferencedFramesObservation | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: DGIMG |
Observation.code | extensible | ObservationType |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:subject, Observation.entryRelationship:purposeofReferenceObservation, Observation.entryRelationship:referencedFramesObservation | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: DGIMG |
Observation.code | extensible | ObservationType |
Observation.code.nullFlavor | required | NullFlavor |
Observation.text.nullFlavor | required | NullFlavor |
Observation.text.compression | required | CompressionAlgorithm |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.statusCode | required | ActStatus |
Observation.effectiveTime.nullFlavor | required | NullFlavor |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:subject, Observation.entryRelationship:purposeofReferenceObservation, Observation.entryRelationship:referencedFramesObservation | Only 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 CDAR2.Observation
Summary
Mandatory: 6 elements (8 nested mandatory elements)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: DGIMG | |
moodCode | 1..1 | code | Required Pattern: EVN | |
id | 1..* | II | The @root contains an OID representing the DICOM SOP Instance UID | |
code | 1..1 | CD | ||
code | C | 1..1 | string | 81-19226: @code is an OID for a valid SOP class name UID (CONF:81-19226). |
codeSystem | 1..1 | string | Required Pattern: 1.2.840.10008.2.6.1 | |
text | 0..1 | ED | ||
mediaType | 1..1 | code | Required Pattern: application/dicom | |
reference | C | 1..1 | TEL | 81-9249: **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). |
effectiveTime | 0..1 | IVL_TS | ||
value | 1..1 | dateTime | ||
low | 0..0 | |||
high | 0..0 | |||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by value:typeCode | |
entryRelationship:subject | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
entryRelationship:purposeofReferenceObservation | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | PurposeofReferenceObservation | Base for all types and resources | |
entryRelationship:referencedFramesObservation | C | 0..* | Element | 81-9263: This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). |
typeCode | 1..1 | code | Required Pattern: COMP | |
observation | 1..1 | ReferencedFramesObservation | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | Base for all types and resources | |
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: DGIMG | |
moodCode | 1..1 | code | Required Pattern: EVN | |
id | 1..* | II | The @root contains an OID representing the DICOM SOP Instance UID | |
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | C | 1..1 | string | 81-19226: @code is an OID for a valid SOP class name UID (CONF:81-19226). |
codeSystem | 1..1 | string | Required Pattern: 1.2.840.10008.2.6.1 | |
text | 0..1 | ED | ||
mediaType | 1..1 | code | Required Pattern: application/dicom | |
reference | C | 1..1 | TEL | 81-9249: **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). |
effectiveTime | 0..1 | IVL_TS | ||
value | 1..1 | dateTime | ||
Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by value:typeCode |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:subject | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
contextConductionInd | 1..1 | boolean | ||
entryRelationship:purposeofReferenceObservation | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: RSON | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | PurposeofReferenceObservation | Base for all types and resources | |
entryRelationship:referencedFramesObservation | C | 0..* | Element | 81-9263: This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). |
typeCode | 1..1 | code | Required Pattern: COMP | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | ReferencedFramesObservation | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: DGIMG |
Observation.code | extensible | ObservationType |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:subject, Observation.entryRelationship:purposeofReferenceObservation, Observation.entryRelationship:referencedFramesObservation | Only 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
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: DGIMG |
Observation.code | extensible | ObservationType |
Observation.code.nullFlavor | required | NullFlavor |
Observation.text.nullFlavor | required | NullFlavor |
Observation.text.compression | required | CompressionAlgorithm |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.statusCode | required | ActStatus |
Observation.effectiveTime.nullFlavor | required | NullFlavor |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
81-9249 | error | Observation.text.reference | **SHALL** contain a @value that contains a WADO reference as a URI (CONF:81-9249). : | |
81-9263 | warning | Observation.entryRelationship:referencedFramesObservation | This entryRelationship SHALL be present if the referenced DICOM object is a multiframe object and the reference does not apply to all frames (CONF:81-9263). : | |
81-19226 | error | Observation.code.code | @code is an OID for a valid SOP class name UID (CONF:81-19226). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:subject, Observation.entryRelationship:purposeofReferenceObservation, Observation.entryRelationship:referencedFramesObservation | Only 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 CDAR2.Observation
Summary
Mandatory: 6 elements (8 nested mandatory elements)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron