Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Imaging Integration icon Work Group Maturity Level : 3   Trial Use Normative Security Category : Patient Compartments : Group , Patient

Detailed Descriptions for the elements in the ImagingStudy resource.

Comments This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test). Alternate Names Alternate Names Alternate Names
Element Id ImagingStudy
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 may can have multiple series of different modalities. modality values.

Short Display A set of images or image-related data produced in single study
Cardinality 0..*
Type DomainResource
Summary false
Constraints
Defined on this element
ist-1 Rule 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 Rule 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 Rule 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 Rule 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 Rule 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 Rule 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 Rule 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()
Element Id ImagingStudy.identifier
Definition

Identifiers for Business identifiers assigned to this imaging study by the ImagingStudy such 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, and Accession Number. UID.

Note Short Display Business identifier for imaging study
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

If 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 elements element values are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2 icon . .)

Alternate Names StudyInstanceUID; AccessionNumber StudyInstanceUID
Summary true
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. Accession Number should use ACSN Identifier type.

Constraints
Affect this element
ist-1 Rule 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 Rule At most, a single identifier SHALL be present with a system of urn:dicom:uid identifier.where(system = 'urn:dicom:uid').count() < 2
Element Id ImagingStudy.status
Definition

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

Short Display registered | available | cancelled | entered-in-error | unknown | inactive
Cardinality 1..1
Terminology Binding ImagingStudyStatus Imaging Study Status ( Required )
Type code
Is Modifier true (Reason: This element is labelled labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not SHOULD NOT be treated as valid)
Summary true
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.

Element Id ImagingStudy.modality
Definition

A list of all All the series.modality distinct values that are actual of series.modality. This MAY be either an acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). or a non-acquisition modality.

Short Display The distinct values for series' modalities
Cardinality 0..*
Terminology Binding AcquisitionModality Modality icon ( Extensible )
Type Coding CodeableConcept
Alternate Names ModalitiesInStudy
Summary true
Constraints
Affect this element
ist-7 Rule 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()
Element Id ImagingStudy.subject
Definition

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

Short Display Who or what is the subject of the study
Cardinality 1..1
Type Reference ( Patient | Device | Group )
Summary true
Comments

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

Element Id ImagingStudy.encounter
Definition

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

Short Display Encounter with which this imaging study is associated
Cardinality 0..1
Type Reference ( Encounter )
Summary true
Element Id ImagingStudy.started
Definition

Date and time the study started.

Short Display When the study was started
Cardinality 0..1
Type dateTime
Alternate Names StudyDate; StudyTime
Summary true
Element Id ImagingStudy.basedOn
Definition

A list of the diagnostic requests plan or order that resulted is fulfilled in whole or in part by this imaging study being performed. study.

Short Display Fulfills plan or order
Cardinality 0..*
Type Reference ( CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task )
Requirements

To support grouped procedures (one Allows tracing of authorization for the imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). 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.

Alternate Names AccessionNumber
Summary true
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.

Element Id ImagingStudy.referrer ImagingStudy.procedure
Definition

The requesting/referring physician. performed procedure(s) during which the data associated with this imaging study was created.

Short Display Imaging performed procedure(s)
Cardinality 0..1 0..*
Type Reference ( Practitioner | PractitionerRole Procedure )
Summary ReferringPhysiciansName true
Summary Comments true

To link an imaging study to an Encounter use encounter .

Element Id ImagingStudy.interpreter ImagingStudy.referrer
Definition

Who read the study and interpreted the images or other content. The referring physician.

Short Display Referring physician
Cardinality 0..* 0..1
Type Reference ( Practitioner | PractitionerRole )
Alternate Names Name of Physician(s) Reading Study ReferringPhysiciansName
Summary true
Element Id ImagingStudy.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.

Short Display Study access endpoint
Cardinality 0..*
Type Reference ( Endpoint )
Requirements

Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s 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.

Summary true
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 information metadata without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer. instances. See Imaging Study Implementation Notes on Endpoints .

Element Id ImagingStudy.numberOfSeries ImagingStudy.location
Definition

Number of Series in the Study. This value given may be larger than The principal physical location where the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present. imaging study was performed.

Short Display Where imaging study occurred
Cardinality 0..1
Type unsignedInt Reference ( Location )
Requirements NumberOfStudyRelatedSeries

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

Summary true
Element Id ImagingStudy.numberOfInstances ImagingStudy.reason
Definition

Number of SOP Instances in Study. This value given may be larger than Describes why the number of instance elements this resource contains due to resource availability, security, imaging study occurred in coded or other factors. This element should be present if any instance elements are present. textual form or indicates another resource whose existence justifies this imaging study.

Short Display Why was imaging study performed?
Cardinality 0..1 0..*
Type Terminology Binding unsignedInt Procedure Reason Codes ( Example )
Type NumberOfStudyRelatedInstances CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference )
Summary true
Comments

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

Element Id ImagingStudy.procedureReference ImagingStudy.note
Definition

The procedure which this ImagingStudy was part of. Comments made about the imaging study by the performer, subject or other participants.

Short Display Comments made about the imaging study
Cardinality 0..1 0..*
Type Reference ( Procedure Annotation )
Summary true
Element Id ImagingStudy.procedureCode ImagingStudy.description
Definition

The code for Description or classification of the performed procedure type. imaging study.

Cardinality Short Display 0..* Study Description or Classification
Terminology Binding Cardinality ImagingProcedureCode : 0..1
Type CodeableConcept string
Alternate Names ProcedureCodeSequence StudyDescription
Summary true
Element Id ImagingStudy.location ImagingStudy.numberOfSeries
Definition

The principal physical location where Number of known Series in the ImagingStudy was performed. Study. This value might be present even if the ImagingStudy.series element is empty or only partially populated.

Short Display Number of Study Related Series
Cardinality 0..1
Type Reference ( Location unsignedInt )
Alternate Names Requirements NumberOfStudyRelatedSeries
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). Summary true
Constraints Summary
Affect this element
ist-3 Rule If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements true numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count()
Element Id ImagingStudy.reasonCode ImagingStudy.numberOfInstances
Definition

Description Number of clinical condition indicating why known SOP Instances in Study. This value might be present even if the ImagingStudy was requested. ImagingStudy.series.instance elements are empty or only partially populated.

Cardinality Short Display 0..* Number of Study Related Instances
Terminology Binding Cardinality Procedure Reason Codes ( Example ) 0..1
Type CodeableConcept unsignedInt
Alternate Names NumberOfStudyRelatedInstances
Summary true
Constraints Element Id ImagingStudy.reasonReference true
ImagingStudy.reasonReference Affect this element
ist-4 Definition Indicates another resource whose existence justifies this Study. Rule Cardinality If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements 0..* numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count()
Type ist-5 Reference ( Condition | Observation | Media | DiagnosticReport | DocumentReference Rule ) If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. Summary numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0)
Element Id ImagingStudy.note ImagingStudy.series
Definition

Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about The set of Series belonging to the imaging study should study. Each Series contains a set of SOP Instances, which could be recorded in another resource, e.g. Observation, and not in this element. images, waveforms, or other content.

Cardinality Short Display 0..* The set of Series belonging to the study
Type Cardinality Annotation 0..*
Summary true
Constraints Element Id Alternate Names true
ImagingStudy.description Affect this element
ist-1 ImagingStudy.description Rule Definition series SHALL only be present if an identifier is present with a system of urn:dicom:uid The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed. series.exists() implies identifier.where(system = 'urn:dicom:uid').exists()
ist-3 Cardinality Rule If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements 0..1 numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count()
Type ist-4 string Rule If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements StudyDescription numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count()
ist-5 Summary Rule If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. true numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0)
ImagingStudy.series ist-6 Element Id ImagingStudy.series Rule Definition For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements Each study has one series.where(numberOfInstances.empty() or more series of images instance.empty() or other content. numberOfInstances = instance.count()).count() = series.count()
Cardinality ist-7 0..* Rule If modality is present, modality SHALL equal all of the distinct values of series.modality Summary 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()
Element Id ImagingStudy.series.uid
Definition

The DICOM Series Instance UID for of the series.

Short Display DICOM Series Instance UID
Cardinality 1..1
Type id
Requirements

DICOM Series Instance UID.

Alternate Names SeriesInstanceUID
Summary true
Comments

See DICOM PS3.3 C.7.3 icon .

Element Id ImagingStudy.series.number
Definition

The numeric identifier of this series in the study.

Short Display Numeric identifier of this series
Cardinality 0..1
Type unsignedInt
Alternate Names SeriesNumber
Summary true
Element Id ImagingStudy.series.modality
Definition

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

Short Display The modality used for this series
Cardinality 1..1
Terminology Binding AcquisitionModality Modality icon ( Extensible )
Type Coding CodeableConcept
Alternate Names Modality
Summary true
Constraints
Affect this element
ist-7 Rule 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()
Element Id ImagingStudy.series.description
Definition

A description Description or classification of the series.

Short Display Series Description or Classification
Cardinality 0..1
Type string
Alternate Names SeriesDescription
Summary true
Element Id ImagingStudy.series.numberOfInstances
Definition

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

Short Display Number of Series Related Instances
Cardinality 0..1
Type unsignedInt
Alternate Names NumberOfSeriesRelatedInstances
Summary true
Constraints Element Id 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; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.
ImagingStudy.series.endpoint Affect this element
ImagingStudy.series.endpoint ist-5 Definition Rule The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if If numberOfInstances and series.numberOfInstances are both present, has precedence over a study-level endpoint with the same Endpoint.connectionType. numberOfInstances value SHALL be the sum of the series.numberOfInstance values. Cardinality numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0) 0..*
Type ist-6 Reference ( Endpoint Rule ) Requirements Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the For each series or element, if numberOfInstances and instance are both present, the series’ instances. A baseLocation specified at numberOfInstances value SHALL match the series level has precedence over a baseLocation number of the same type specified at the study level. instance elements Summary series.where(numberOfInstances.empty() or instance.empty() or numberOfInstances = instance.count()).count() = series.count() true
Element Id ImagingStudy.series.bodySite ImagingStudy.series.endpoint
Definition

The anatomic structures examined. network service providing access for the study. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) implementation notes for information about using DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. endpoints .

Cardinality Short Display 0..1 Series access endpoint
Terminology Binding Cardinality SNOMED CT Body Structures ( Example ) 0..*
Type Coding Reference Alternate Names BodyPartExamined ( Endpoint )
Summary true
Element Id ImagingStudy.series.laterality ImagingStudy.series.bodySite
Definition

The laterality of the (possibly paired) anatomic structures examined. E.g., See DICOM Part 16 Annex L icon for DICOM to SNOMED-CT mappings. The bodySite MAY include the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. of body part imaged.

Short Display Body part examined
Cardinality 0..1
Terminology Binding Laterality SNOMED CT Body Structures ( Example )
Type Coding CodeableReference ( BodyStructure )
Alternate Names BodyPartExamined
Summary true
Element Id ImagingStudy.series.specimen
Definition

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

Short Display Specimen imaged
Cardinality 0..*
Type Reference ( Specimen )
Summary true
Element Id ImagingStudy.series.started
Definition

The date and time the series was started.

Short Display When the series started
Cardinality 0..1
Type dateTime
Summary true
Element Id ImagingStudy.series.performer
Definition

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

Short Display Who performed the series
Cardinality 0..*
Requirements

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

Alternate Names PerformingPhysicianName; OperatorName OperatorName; ManufacturersModelName; InstitutionName
Summary true
Comments

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

Element Id ImagingStudy.series.performer.function
Definition

Distinguishes the type of involvement of the performer in the series. imaging study..

Short Display Type of performance
Cardinality 0..1
Terminology Binding ImagingStudy series performer function ( Extensible )
Type CodeableConcept
Requirements

Allows disambiguation of the types of involvement of different performers.

Summary true
Element Id ImagingStudy.series.performer.actor
Definition

Indicates who or what performed the series. imaging study.

Short Display Who performed imaging study
Cardinality 1..1
Type Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService )
Summary true
Element Id ImagingStudy.series.instance
Definition

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

Short Display A single SOP instance from the series
Cardinality 0..*
Summary false
Constraints
Affect this element
ist-4 Rule 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-6 Rule 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()
Element Id ImagingStudy.series.instance.uid
Definition

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

Short Display DICOM SOP Instance UID
Cardinality 1..1
Type id
Requirements

DICOM SOP Instance UID.

Alternate Names SOPInstanceUID
Comments Summary false
Comments

See DICOM PS3.3 C.12.1 icon .

Element Id ImagingStudy.series.instance.sopClass
Definition

DICOM instance type.

Cardinality Short Display 1..1 DICOM class type
Terminology Binding Cardinality sopClass : 1..1
Type Coding oid
Alternate Names SOPClassUID
Summary false
Comments

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

Element Id ImagingStudy.series.instance.number
Definition

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

Short Display The number of this instance in the series
Cardinality 0..1
Type unsignedInt
Alternate Names InstanceNumber
Summary false
Element Id ImagingStudy.series.instance.title
Definition

The description title of the instance.

Short Display Name or title of the instance
Cardinality 0..1
Type string
Comments Summary false
Comments

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