type: resource-definitionsresource: ImagingStudy

ImagingStudy Definitions

ImagingStudy

A set of images or image-related data produced in single study

Definition: Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study can have multiple series of different modality values.

Cardinality: 0..*

Constraints: ist-1 | error | series SHALL only be present if an identifier is present with a system of urn:dicom:uid | series.exists() implies identifier.where(system = 'urn:dicom:uid').exists(); ist-2 | error | At most, a single identifier SHALL be present with a system of urn:dicom:uid | identifier.where(system = 'urn:dicom:uid').count() < 2; ist-3 | error | If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements | numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count(); ist-4 | error | If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements | numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count(); ist-5 | error | If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. | numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0); ist-6 | error | For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements | series.where(numberOfInstances.empty() or instance.empty() or numberOfInstances = instance.count()).count() = series.count(); ist-7 | error | If modality is present, modality SHALL equal all of the distinct values of series.modality | modality.exists() implies modality.coding.select(system&'|'&code).trace('r').exclude(series.modality.coding.select(system&'|'&code).trace('c')).empty() and modality.text.exclude(series.modality.text).empty() and series.modality.coding.select(system&'|'&code).trace('r').exclude(modality.coding.select(system&'|'&code).trace('c')).empty() and series.modality.text.exclude(modality.text).empty()

Mappings: workflow=Event; rim=Act[classCode=COMPOSITION, moodCode=EVN]; dicom=DICOM Tag Mapping; w5=clinical.diagnostics

ImagingStudy.identifier

Business identifier for imaging study

Definition: Business identifiers assigned to this imaging study by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Typically this will include the DICOM Study Instance UID.

Comments: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices MAY occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number, or an accession number MAY be used to relate a Task, an ImagingStudy and a DiagnosticReport. See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID.

Requirements: Allows identification of the imaging study as it is known by various participating systems and in a way that remains consistent across servers. ImagingStudy.identifier SHALL include exactly one Study Instance UID value if one or more series element values are present (see DICOM PS 3.3 C.7.2.)

Aliases: StudyInstanceUID

Conditions: ist-1, ist-2

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Event.identifier; w5=FiveWs.identifier; rim=.id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id; dicom=Study Instance UID (0020,000D) and / or Study ID (0020,0010)

ImagingStudy.status

Definition: The current state of the imaging study. This is distinct from the status of any service request or task associated with the imaging study.

Comments: Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Cardinality: 1..1

Type: code

Binding: required:imagingstudy-status

Summary: true

Is Modifier: true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource SHOULD NOT be treated as valid)

Mappings: workflow=Event.status; w5=FiveWs.status; v2=Varies by domain; rim=.status

ImagingStudy.modality

The distinct values for series' modalities

Definition: All the distinct values of series.modality. This MAY be either an acquisition or a non-acquisition modality.

Aliases: ModalitiesInStudy

Conditions: ist-7

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:sect_CID_33.html

Summary: true

Mappings: w5=FiveWs.class; rim=.code; dicom=Modalities in Study (0008,0061) or Modality (0008,0060)

ImagingStudy.subject

Who or what is the subject of the study

Definition: The subject, typically a patient, of the imaging study.

Comments: QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.

Cardinality: 1..1

Type: Reference(Patient, Device, Group)

Summary: true

Mappings: workflow=Event.subject; w5=FiveWs.subject; rim=.participation[typeCode=SBJ].role; dicom=Patient ID (0010,0020) and Issuer of Patient ID (0010,0021) and / or Issuer of Patient ID Qualifiers Sequence (0010,0024) and / or Patient Name (0010,0010)

ImagingStudy.encounter

Encounter with which this imaging study is associated

Definition: The healthcare event (e.g. a patient and healthcare provider interaction) during which the imaging data represented by this imaging study was acquired.

Cardinality: 0..1

Type: Reference(Encounter)

Summary: true

Mappings: workflow=Event.encounter; w5=FiveWs.context; rim=inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

ImagingStudy.started

When the study was started

Definition: Date and time the study started.

Aliases: StudyDate, StudyTime

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Event.occurrence[x]; w5=FiveWs.init; rim=.effectiveTime; dicom=Study Date (0008,0020) and Study Time (0008,0030)

ImagingStudy.basedOn

Fulfills plan or order

Definition: A plan or order that is fulfilled in whole or in part by this imaging study.

Comments: One imaging study MAY be based on multiple ordered procedures, e.g. chest/abdomen/pelvis CT orders being fulfilled by a single imaging study.

Requirements: Allows tracing of authorization for the imaging study and tracking whether proposals/recommendations were acted upon. If the ImagingStudy is associated with an Accession Number, this field SHOULD include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required.

Aliases: AccessionNumber

Cardinality: 0..*

Type: Reference(CarePlan, ServiceRequest, Appointment, Task)

Summary: true

Mappings: workflow=Event.basedOn; w5=FiveWs.cause; rim=.outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]; dicom=Accession Number (0080,0050) and Issuer of Accession Number Sequence (0080,0051) and / or Requested Procedure Code Sequence (0032,1064)

ImagingStudy.procedure

Imaging performed procedure(s)

Definition: The performed procedure(s) during which the data associated with this imaging study was created.

Comments: To link an imaging study to an Encounter use encounter.

Cardinality: 0..*

Type: Reference(Procedure)

Summary: true

Mappings: workflow=Event.partOf; v2=Varies by domain; rim=.outboundRelationship[typeCode=FLFS].target

ImagingStudy.referrer

Referring physician

Definition: The referring physician.

Aliases: ReferringPhysiciansName

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole)

Summary: true

Mappings: w5=FiveWs.cause; rim=.outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role; dicom=Referring Physician's Name (0008,0090) and Referring Physician Identification Sequence (0008,0096)

ImagingStudy.endpoint

Study access endpoint

Definition: The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

Comments: Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM metadata without retrieving the actual instances. See Imaging Study Implementation Notes on Endpoints.

Requirements: Access methods for viewing or retrieving the study or the study's series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.

Cardinality: 0..*

Type: Reference(Endpoint)

Summary: true

Mappings: rim=Not supported

ImagingStudy.location

Where imaging study occurred

Definition: The principal physical location where the imaging study was performed.

Requirements: Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

Cardinality: 0..1

Type: Reference(Location)

Summary: true

Mappings: workflow=Event.location; w5=FiveWs.where[x]; v2=EVN-7; rim=.participation[typeCode=LOC].role; dicom=Institutional Department Name (0008,1040) and Institutional Department Type Code Sequence (0008,1041)

ImagingStudy.reason

Why was imaging study performed?

Definition: Describes why the imaging study occurred in coded or textual form or indicates another resource whose existence justifies this imaging study.

Comments: This MAY correspond to the indications or reasons encoded in an associated service request.

Cardinality: 0..*

Type: CodeableReference

Binding: example:procedure-reason

Summary: true

Mappings: workflow=Event.reason; w5=FiveWs.why[x]; rim=.reasonCode; dicom=Reason for Requested Procedure Code Sequence (0040,1002)

ImagingStudy.note

Comments made about the imaging study

Definition: Comments made about the imaging study by the performer, subject or other participants.

Cardinality: 0..*

Type: Annotation

Summary: true

Mappings: workflow=Event.note

ImagingStudy.description

Study Description or Classification

Definition: Description or classification of the imaging study.

Aliases: StudyDescription

Cardinality: 0..1

Type: string

Summary: true

Mappings: rim=.text; dicom=Study Description (0008,1030)

ImagingStudy.numberOfSeries

Number of Study Related Series

Definition: Number of known Series in the Study. This value might be present even if the ImagingStudy.series element is empty or only partially populated.

Aliases: NumberOfStudyRelatedSeries

Conditions: ist-3

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: rim=.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber; dicom=Number of Study Related Series (0020,1206). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.

ImagingStudy.numberOfInstances

Number of Study Related Instances

Definition: Number of known SOP Instances in Study. This value might be present even if the ImagingStudy.series.instance elements are empty or only partially populated.

Aliases: NumberOfStudyRelatedInstances

Conditions: ist-4, ist-5

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: rim=.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber; dicom=Number of Study Related Instances (0020,1208). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.

ImagingStudy.series

The set of Series belonging to the study

Definition: The set of Series belonging to the study. Each Series contains a set of SOP Instances, which could be images, waveforms, or other content.

Conditions: ist-1, ist-3, ist-4, ist-5, ist-6, ist-7

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: rim=.outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]

ImagingStudy.series.uid

DICOM Series Instance UID

Definition: The DICOM Series Instance UID of the series.

Comments: See DICOM PS3.3 C.7.3.

Requirements: DICOM Series Instance UID.

Aliases: SeriesInstanceUID

Cardinality: 1..1

Type: id

Summary: true

Mappings: rim=.id; dicom=Series Instance UID (0020,000E)

ImagingStudy.series.number

Numeric identifier of this series

Definition: The numeric identifier of this series in the study.

Aliases: SeriesNumber

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: rim=.inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber; dicom=Series Number (0020,0011)

ImagingStudy.series.modality

The modality used for this series

Definition: The distinct modality for this series. This MAY be either an acquisition modality (e.g., CT, MR) or a non-acquisition modality (e.g., segmentation, presentation state).

Aliases: Modality

Conditions: ist-7

Cardinality: 1..1

Type: CodeableConcept

Binding: extensible:sect_CID_33.html

Summary: true

Mappings: rim=.code; dicom=Modality (0008,0060)

ImagingStudy.series.description

Series Description or Classification

Definition: Description or classification of the series.

Aliases: SeriesDescription

Cardinality: 0..1

Type: string

Summary: true

Mappings: rim=.text; dicom=Series Description (0008,103E)

ImagingStudy.series.numberOfInstances

Number of Series Related Instances

Definition: Number of SOP Instances in the Series. The value given MAY be larger than the number of instance elements this series contains due to resource availability, security, or other factors. This element SHOULD be present if any instance elements are present.

Aliases: NumberOfSeriesRelatedInstances

Conditions: ist-5, ist-6

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: rim=.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber; dicom=Number of Series Related Instances (0020,1209). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.

ImagingStudy.series.endpoint

Series access endpoint

Definition: The network service providing access for the study. See implementation notes for information about using DICOM endpoints.

Cardinality: 0..*

Type: Reference(Endpoint)

Summary: true

Mappings: rim=Not supported

ImagingStudy.series.bodySite

Body part examined

Definition: The anatomic structures examined. See DICOM Part 16 Annex L for DICOM to SNOMED-CT mappings. The bodySite MAY include the laterality of body part imaged.

Aliases: BodyPartExamined

Cardinality: 0..1

Type: CodeableReference

Binding: example:body-site

Summary: true

Mappings: rim=.targetSiteCode; dicom=Body Part Examined (0018,0015) or Anatomic Region Sequence (0008,2218) and Laterality (0020,0060)

ImagingStudy.series.specimen

Specimen imaged

Definition: The specimen imaged, e.g., for whole slide imaging of a biopsy.

Cardinality: 0..*

Type: Reference(Specimen)

Summary: true

Mappings: rim=Role[classCode=SPEC]; dicom=Specimen Identifier (0040,0551) or Specimen UID (0040,0554) and + Issuer of the Specimen Identifier Sequence (0040,0562)

ImagingStudy.series.started

When the series started

Definition: The date and time the series was started.

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: rim=.effectiveTime; dicom=Series Date (0008,0021) + and Series Time (0008,0031)

ImagingStudy.series.performer

Who performed the series

Definition: Indicates who or what performed the series and how they were involved.

Comments: If the person who performed the series is not known, their Organization MAY be recorded. A patient, or related person, MAY be the performer, e.g. for patient-captured images.

Requirements: The performer is recorded at the series level, since each series in a study MAY be performed by a different performer, at different times, and using different devices. A series MAY be performed by multiple performers.

Aliases: PerformingPhysicianName, OperatorName, ManufacturersModelName, InstitutionName

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: workflow=Event.performer; rim=.participation[typeCode=PRF].role; dicom=One or more of: Performing Physician's Name (0008,1050) and Performing Physician Identification Sequence (0008,1052); Operators' Name (0008,1070) and Operator Identification Sequence (0008,1072); Manufacturer (0008,0070) and Manufacturer's Model Name (0008,1090); or Institution Name (0008,0080)

ImagingStudy.series.performer.function

Type of performance

Definition: Distinguishes the type of involvement of the performer in the imaging study..

Requirements: Allows disambiguation of the types of involvement of different performers.

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:series-performer-function

Summary: true

Mappings: workflow=Event.performer.function; rim=.participation[typeCode=PRF].role; dicom=PRF (Performing Physician's Name); SPRF (Operator's Name); DEV (Manufacturer / Manufacturer's Model Name); or LOC (Institution Name)

ImagingStudy.series.performer.actor

Who performed imaging study

Definition: Indicates who or what performed the imaging study.

Cardinality: 1..1

Type: Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson, HealthcareService)

Summary: true

Mappings: workflow=Event.performer.actor; w5=FiveWs.actor; v2=EVN-5 or by domain; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]; dicom=Practitioner (Performing Physician's Name); Practitioner (Operator's Name); Device (Manufacturer / Manufacturer's Model Name); or Organization (Institution Name)

ImagingStudy.series.instance

A single SOP instance from the series

Definition: A single SOP instance within the series, e.g. an image, or presentation state.

Conditions: ist-4, ist-6

Cardinality: 0..*

Type: BackboneElement

Mappings: rim=.outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]

ImagingStudy.series.instance.uid

DICOM SOP Instance UID

Definition: The DICOM SOP Instance UID for this image or other DICOM content.

Comments: See DICOM PS3.3 C.12.1.

Requirements: DICOM SOP Instance UID.

Aliases: SOPInstanceUID

Cardinality: 1..1

Type: id

Mappings: rim=.id; dicom=SOP Instance UID (0008,0018)

ImagingStudy.series.instance.sopClass

DICOM class type

Definition: DICOM instance type.

Comments: Typically a well-known DICOM SOP Class UID but MAY be the UID of a private SOP Class

Aliases: SOPClassUID

Cardinality: 1..1

Type: oid

Mappings: rim=.inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code="sop class"].value; dicom=SOP Class UID (0008,0016)

ImagingStudy.series.instance.number

The number of this instance in the series

Definition: The number of the instance assigned by the creator of the series. MAY or MAY NOT correspond to intended display order.

Aliases: InstanceNumber

Cardinality: 0..1

Type: unsignedInt

Mappings: rim=.inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber; dicom=Instance Number (0020,0013)

ImagingStudy.series.instance.title

Name or title of the instance

Definition: The title of the instance.

Comments: Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.

Cardinality: 0..1

Type: string

Mappings: rim=.title; dicom=Document Title (0042,0010)