FHIR ImagingStudy Resource

Metadata about a DICOM imaging study — modality, body site, series, and instance UIDs. Does not contain pixel data; actual images are in linked Media resources. This page documents the ImagingStudy resource as served by the mock.health synthetic FHIR R4 sandbox — 7 search parameters, US Core 6.1 profiling, and the elements accepted on write.

Endpoints

• GET https://api.mock.health/fhir/ImagingStudy — search
• GET https://api.mock.health/fhir/ImagingStudy/{id} — read by logical id
• POST https://api.mock.health/fhir/ImagingStudy — create (Pro)
• PUT https://api.mock.health/fhir/ImagingStudy/{id} — update (Pro)

Search parameters

• patient (reference) — required — Patient the study is about
• status (token) — registered | available | cancelled | entered-in-error
• modality (token) — DICOM modality code (CT, MR, DX, US, etc.)
• bodysite (token) — SNOMED body site code
• started (date) — When the study was started
• identifier (token) — Study instance UID or other identifier
• encounter (reference) — Encounter during which the study was performed

Write elements

Fields accepted when creating or updating a ImagingStudy. Required elements are base FHIR cardinality; the rest are US Core must-support.

• status (code) — required — registered | available | cancelled | entered-in-error
• subject (Reference(Patient)) — required — Patient the imaging study is about
• series.modality (Coding) — DICOM modality (CT, MR, DX, US, etc.) on each series
• started (dateTime) — Date/time the study started
• numberOfSeries (unsignedInt) — Number of series in the study
• numberOfInstances (unsignedInt) — Total number of instances across all series

Notes

ImagingStudy is metadata only — it contains DICOM UIDs, modality, and body site but not pixel data. To retrieve the actual image, follow the DiagnosticReport that references this study via .imagingStudy, then follow .media[].link to get the Media ID. Use GET /api/media/{id}/content to download raw DICOM bytes, or GET /api/media/{id}/render for a PNG preview.

Specification

Base definition: HL7 FHIR R4 ImagingStudy. Category: Diagnostics.

Related diagnostics resources

DiagnosticReport · Media · Observation · ServiceRequest · Specimen

API reference · Quickstart · USCDI compliance · SMART on FHIR