Skip to main content

ImagingStudy

ResourceClinical · DiagnosticsTrial useMaturity 3

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.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
17 of 17 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierIdentifiers for the whole study
statusRequired?!Σ
1..1coderegistered | available | cancelled | entered-in-error | unknownBinding (required): imagingstudy-status
modalityΣ
0..*CodingAll series modality if actual acquisition modalitiesBinding (extensible): sect_CID_29.html
subjectRequiredΣ
1..1Reference(Patient | Device | Group)Who or what is the subject of the study
encounterΣ
0..1Reference(Encounter)Encounter with which this imaging study is associated
startedΣ
0..1dateTimeWhen the study was started
basedOnΣ
0..*Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)Request fulfilled
referrerΣ
0..1Reference(Practitioner | PractitionerRole)Referring physician
interpreterΣ
0..*Reference(Practitioner | PractitionerRole)Who interpreted images
endpointΣ
0..*Reference(Endpoint)Study access endpoint
numberOfSeriesΣ
0..1unsignedIntNumber of Study Related Series
numberOfInstancesΣ
0..1unsignedIntNumber of Study Related Instances
procedureReferenceΣ
0..1Reference(Procedure)The performed Procedure reference
procedureCodeΣ
0..*CodeableConceptThe performed procedure codeBinding (extensible): RadLex_Playbook.aspx
locationΣ
0..1Reference(Location)Where ImagingStudy occurred
reasonCodeΣ
0..*CodeableConceptWhy the study was requestedBinding (example): procedure-reason
reasonReferenceΣ
0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
noteΣ
0..*AnnotationUser-defined comments
descriptionΣ
0..1stringInstitution-generated description
seriesΣ
0..*BackboneElementEach study has one or more series of instances
uidRequiredΣ
1..1idDICOM Series Instance UID for the series
numberΣ
0..1unsignedIntNumeric identifier of this series
modalityRequiredΣ
1..1CodingThe modality of the instances in the seriesBinding (extensible): sect_CID_29.html
descriptionΣ
0..1stringA short human readable summary of the series
numberOfInstancesΣ
0..1unsignedIntNumber of Series Related Instances
endpointΣ
0..*Reference(Endpoint)Series access endpoint
bodySiteΣ
0..1CodingBody part examinedBinding (example): body-site
lateralityΣ
0..1CodingBody part lateralityBinding (example): bodysite-laterality
specimenΣ
0..*Reference(Specimen)Specimen imaged
startedΣ
0..1dateTimeWhen the series started
performerΣ
0..*BackboneElementWho performed the series
functionΣ
0..1CodeableConceptType of performanceBinding (extensible): series-performer-function
actorRequiredΣ
1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Who performed the series
instance
0..*BackboneElementA single SOP instance from the series
uidRequired
1..1idDICOM SOP Instance UID
sopClassRequired
1..1CodingDICOM class typeBinding (extensible): sect_B.5.html#table_B.5-1
number
0..1unsignedIntThe number of this instance in the series
title
0..1stringDescription of instance

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/ImagingStudy?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
basedonreference

The order for the image

ImagingStudy.basedOn
bodysitetoken

The body site studied

ImagingStudy.series.bodySite
dicom-classtoken

The type of the instance

ImagingStudy.series.instance.sopClass
encounterreference

The context of the study

ImagingStudy.encounter
endpointreference

The endpoint for the study or series

ImagingStudy.endpoint | ImagingStudy.series.endpoint
identifiertoken

Identifiers for the Study, such as DICOM Study Instance UID and Accession number

ImagingStudy.identifier
instancetoken

SOP Instance UID for an instance

ImagingStudy.series.instance.uid
interpreterreference

Who interpreted the images

ImagingStudy.interpreter
modalitytoken

The modality of the series

ImagingStudy.series.modality
patientreference

Who the study is about

ImagingStudy.subject.where(resolve() is Patient)
performerreference

The person who performed the study

ImagingStudy.series.performer.actor
reasontoken

The reason for the study

ImagingStudy.reasonCode
referrerreference

The referring physician

ImagingStudy.referrer
seriestoken

DICOM Series Instance UID for a series

ImagingStudy.series.uid
starteddate

When the study was started

ImagingStudy.started
statustoken

The status of the study

ImagingStudy.status
subjectreference

Who the study is about

ImagingStudy.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition