ImagingStudy
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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| 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 | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Identifiers for the whole study |
status | code | 1..1 | registered | available | cancelled | entered-in-error | unknown |
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 |
|---|---|---|
basedon | reference | The order for the image |
bodysite | token | The body site studied |
dicom-class | token | The type of the instance |
encounter | reference | The context of the study |
endpoint | reference | The endpoint for the study or series |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
instance | token | SOP Instance UID for an instance |
interpreter | reference | Who interpreted the images |
modality | token | The modality of the series |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
performer | reference | The person who performed the study |
reason | token | The reason for the study |
referrer | reference | The referring physician |
series | token | DICOM Series Instance UID for a series |
started | date | When the study was started |
status | token | The status of the study |
subject | reference | Who the study is about |
Reference
Official FHIR R4 spec: ImagingStudy.
Maturity: Trial Use 3 (FMM 3).