ImagingStudy

Trial Use 3 Clinical — Diagnostics

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

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/ImagingStudy

Interaction	Method	Path
Read	GET	/fhir/R4/ImagingStudy/[id]
Vread	GET	/fhir/R4/ImagingStudy/[id]/_history/[vid]
Update	PUT	/fhir/R4/ImagingStudy/[id]
Patch	PATCH	/fhir/R4/ImagingStudy/[id]
Delete	DELETE	/fhir/R4/ImagingStudy/[id]
Create	POST	/fhir/R4/ImagingStudy
Search	GET	/fhir/R4/ImagingStudy
History	GET	/fhir/R4/ImagingStudy/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Identifiers for the whole study
status	code	1..1	registered | available | cancelled | entered-in-error | unknown modifier
modality	Coding	0..*	All series modality if actual acquisition modalities
subject	Reference	1..1	Who or what is the subject of the study
encounter	Reference	0..1	Encounter with which this imaging study is associated
started	dateTime	0..1	When the study was started
basedOn	Reference	0..*	Request fulfilled
referrer	Reference	0..1	Referring physician
interpreter	Reference	0..*	Who interpreted images
endpoint	Reference	0..*	Study access endpoint
numberOfSeries	unsignedInt	0..1	Number of Study Related Series
numberOfInstances	unsignedInt	0..1	Number of Study Related Instances
procedureReference	Reference	0..1	The performed Procedure reference
procedureCode	CodeableConcept	0..*	The performed procedure code
location	Reference	0..1	Where ImagingStudy occurred
reasonCode	CodeableConcept	0..*	Why the study was requested
reasonReference	Reference	0..*	Why was study performed
note	Annotation	0..*	User-defined comments
description	string	0..1	Institution-generated description
series	BackboneElement	0..*	Each study has one or more series of instances

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
basedon	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon
bodysite	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite
dicom-class	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class
encounter	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-encounter
endpoint	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-endpoint
identifier	string	http://hl7.org/fhir/SearchParameter/clinical-identifier
instance	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-instance
interpreter	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-interpreter
modality	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-modality
patient	string	http://hl7.org/fhir/SearchParameter/clinical-patient
performer	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-performer
reason	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-reason
referrer	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-referrer
series	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-series
started	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-started
status	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-status
subject	string	http://hl7.org/fhir/SearchParameter/ImagingStudy-subject

Reference

• Official FHIR R4 spec: ImagingStudy
• Maturity: Trial Use 3 (FMM 3).