FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Imaging Integration icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Patient Compartments: Group, Patient

Detailed Descriptions for the elements in the ImagingStudy resource.

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 have multiple series of different modality values.

Short Display A set of images or image-related data produced in single study
Cardinality 0..*
Type DomainResource
Summary false
Element Id ImagingStudy.identifier
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.

Short Display Business identifier for imaging study
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
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 include exactly one Study Instance UID value if one or more series element values are present (see DICOM PS 3.3 C.7.2 icon.)

Alternate Names 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.

Element Id 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.

Short Display registered | available | cancelled | entered-in-error | unknown | inactive
Cardinality 1..1
Terminology Binding Imaging Study Status (Required)
Type code
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)
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

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

Short Display The distinct values for series' modalities
Cardinality 0..*
Terminology Binding Modality icon (Extensible)
Type CodeableConcept
Alternate Names ModalitiesInStudy
Summary true
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 this ImagingStudy is made.

Short Display Encounter with which this imaging study is associated
Cardinality 0..1
Type Reference(Encounter)
Summary true
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).

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 plan or order that is fulfilled in whole or in part by this imaging study.

Short Display Fulfills plan or order
Cardinality 0..*
Type Reference(CarePlan | ServiceRequest | Appointment | Task)
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.

Alternate Names AccessionNumber
Summary true
Comments

One imaging study MAY support multiple ordered procedures, e.g. chest/abdomen/pelvis CT orders being fulfilled by a single imaging study.

Element Id ImagingStudy.partOf
Definition

A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.

Short Display Part of referenced event
Cardinality 0..*
Type Reference(Procedure)
Summary true
Comments

To link an ImagingStudy to an Encounter use encounter.

Element Id ImagingStudy.referrer
Definition

The referring physician.

Short Display Referring physician
Cardinality 0..1
Type Reference(Practitioner | PractitionerRole)
Alternate Names 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 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 without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer. See Imaging Study Implementation Notes on Endpoints.

Element Id ImagingStudy.procedure
Definition

A procedure or set of procedures during which this imaging study data was created.

Short Display Associated procedure(s)
Cardinality 0..*
Terminology Binding ImagingProcedureCode icon:
Type CodeableReference(PlanDefinition | ActivityDefinition)
Summary true
Element Id ImagingStudy.location
Definition

The principal physical location where the imaging study was performed.

Short Display Where imaging study occurred
Cardinality 0..1
Type Reference(Location)
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).

Summary true
Element Id ImagingStudy.reason
Definition

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

Short Display Why was imaging study performed?
Cardinality 0..*
Terminology Binding Procedure Reason Codes (Example)
Type CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)
Summary true
Element Id ImagingStudy.note
Definition

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

Short Display Comments made about the imaging study
Cardinality 0..*
Type Annotation
Summary true
Element Id ImagingStudy.description
Definition

Description or classification of the imaging study.

Short Display Study Description or Classification
Cardinality 0..1
Type string
Alternate Names StudyDescription
Summary true
Element Id ImagingStudy.numberOfSeries
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.

Short Display Number of Study Related Series
Cardinality 0..1
Type unsignedInt
Alternate Names NumberOfStudyRelatedSeries
Summary true
Element Id ImagingStudy.numberOfInstances
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.

Short Display Number of Study Related Instances
Cardinality 0..1
Type unsignedInt
Alternate Names NumberOfStudyRelatedInstances
Summary true
Element Id ImagingStudy.series
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.

Short Display The set of Series belonging to the study
Cardinality 0..*
Summary true
Element Id ImagingStudy.series.uid
Definition

The DICOM Series Instance UID 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 for this series. This MAY include both acquisition and non-acquisition modalities.

Short Display The modality used for this series
Cardinality 1..1
Terminology Binding Modality icon (Extensible)
Type CodeableConcept
Alternate Names Modality
Summary true
Element Id ImagingStudy.series.description
Definition

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. The value given MAY be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element 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
Element Id ImagingStudy.series.endpoint
Definition

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

Short Display Series access endpoint
Cardinality 0..*
Type Reference(Endpoint)
Summary true
Element Id ImagingStudy.series.bodySite
Definition

The anatomic structures examined. See DICOM Part 16 Annex L icon for 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.

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

The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, SHALL be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

Short Display Body part laterality
Cardinality 0..1
Terminology Binding Laterality icon (Example)
Type CodeableConcept
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 be performed by a different performer, at different times, and using different devices. A series MAY be performed by multiple performers.

Alternate Names PerformingPhysicianName; OperatorName
Summary true
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.

Element Id ImagingStudy.series.performer.function
Definition

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

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.

Short Display Who performed the series
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
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
Summary false
Comments

See DICOM PS3.3 C.12.1 icon.

Element Id ImagingStudy.series.instance.sopClass
Definition

DICOM instance type.

Short Display DICOM class type
Cardinality 1..1
Type oid
Alternate Names SOPClassUID
Summary false
Element Id ImagingStudy.series.instance.number
Definition

The number of instance in the series.

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 of the instance.

Short Display Description of instance
Cardinality 0..1
Type string
Summary false
Comments

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