This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Imaging Integration Work Group | Maturity Level: 3 | Trial Use | Security Category: Patient | Compartments: Patient |
Detailed Descriptions for the elements in the ImagingStudy resource.
ImagingStudy | |
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 modalities. |
Cardinality | 0..* |
Type | DomainResource |
ImagingStudy.identifier | |
Element Id | ImagingStudy.identifier |
Definition | Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2 . |
Alternate Names | StudyInstanceUID; AccessionNumber |
Summary | true |
Comments | See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. Accession Number should use ACSN Identifier type. |
ImagingStudy.status | |
Element Id | ImagingStudy.status |
Definition | The current state of the ImagingStudy. |
Cardinality | 1..1 |
Terminology Binding | ImagingStudyStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled 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. |
ImagingStudy.modality | |
Element Id | ImagingStudy.modality |
Definition | A list of all the distinct values of series.modality. This may include both aquisition and non-aquisition modalities. |
Cardinality | 0..* |
Terminology Binding | ImagingModality : |
Type | Coding |
Alternate Names | ModalitiesInStudy |
Summary | true |
ImagingStudy.subject | |
Element Id | ImagingStudy.subject |
Definition | The subject, typically a patient, of the imaging study. |
Cardinality | 1..1 |
Type | Reference(Patient | Device | Group) |
Patterns | Reference(Patient,Device,Group): Common patterns = Participant |
Summary | true |
Comments | QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group. |
ImagingStudy.encounter | |
Element Id | ImagingStudy.encounter |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
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). |
ImagingStudy.started | |
Element Id | ImagingStudy.started |
Definition | Date and time the study started. |
Cardinality | 0..1 |
Type | dateTime |
Alternate Names | StudyDate; StudyTime |
Summary | true |
ImagingStudy.basedOn | |
Element Id | ImagingStudy.basedOn |
Definition | A list of the diagnostic requests that resulted in this imaging study being performed. |
Cardinality | 0..* |
Type | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) |
Patterns | Reference(CarePlan,ServiceRequest,Appointment,AppointmentResponse,Task): No common pattern |
Requirements | To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). |
Summary | true |
ImagingStudy.referrer | |
Element Id | ImagingStudy.referrer |
Definition | The requesting/referring physician. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole) |
Patterns | Reference(Practitioner,PractitionerRole): Common patterns = Participant |
Alternate Names | ReferringPhysiciansName |
Summary | true |
ImagingStudy.interpreter | |
Element Id | ImagingStudy.interpreter |
Definition | Who read the study and interpreted the images or other content. |
Cardinality | 0..* |
Type | Reference(Practitioner | PractitionerRole) |
Patterns | Reference(Practitioner,PractitionerRole): Common patterns = Participant |
Alternate Names | Name of Physician(s) Reading Study |
Summary | true |
ImagingStudy.endpoint | |
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. |
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. |
ImagingStudy.numberOfSeries | |
Element Id | ImagingStudy.numberOfSeries |
Definition | Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present. |
Cardinality | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedSeries |
Summary | true |
ImagingStudy.numberOfInstances | |
Element Id | ImagingStudy.numberOfInstances |
Definition | Number of SOP Instances in Study. This 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. |
Cardinality | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedInstances |
Summary | true |
ImagingStudy.procedure | |
Element Id | ImagingStudy.procedure |
Definition | The procedure or code from which this ImagingStudy was part of. |
Cardinality | 0..* |
ImagingStudy.procedure.value[x] | |
Element Id | ImagingStudy.procedure.value[x] |
Definition | The procedure which this ImagingStudy was part of. |
Cardinality | 1..1 |
Terminology Binding | ImagingProcedureCode : |
Type | Reference(Procedure)|CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
ImagingStudy.location | |
Element Id | ImagingStudy.location |
Definition | The principal physical location where the ImagingStudy was performed. |
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 |
ImagingStudy.reason | |
Element Id | ImagingStudy.reason |
Definition | Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study. |
Cardinality | 0..* |
Terminology Binding | Procedure Reason Codes (Example) |
Type | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) |
Patterns | CodeableReference(Condition,Observation,DiagnosticReport,DocumentReference): Common patterns = Event |
Summary | true |
ImagingStudy.note | |
Element Id | ImagingStudy.note |
Definition | Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element. |
Cardinality | 0..* |
Type | Annotation |
Summary | true |
ImagingStudy.description | |
Element Id | ImagingStudy.description |
Definition | The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed. |
Cardinality | 0..1 |
Type | string |
Alternate Names | StudyDescription |
Summary | true |
ImagingStudy.series | |
Element Id | ImagingStudy.series |
Definition | Each study has one or more series of images or other content. |
Cardinality | 0..* |
Summary | true |
ImagingStudy.series.uid | |
Element Id | ImagingStudy.series.uid |
Definition | The DICOM Series Instance UID for the series. |
Cardinality | 1..1 |
Type | id |
Requirements | DICOM Series Instance UID. |
Alternate Names | SeriesInstanceUID |
Summary | true |
Comments | See DICOM PS3.3 C.7.3 . |
ImagingStudy.series.number | |
Element Id | ImagingStudy.series.number |
Definition | The numeric identifier of this series in the study. |
Cardinality | 0..1 |
Type | unsignedInt |
Alternate Names | SeriesNumber |
Summary | true |
ImagingStudy.series.modality | |
Element Id | ImagingStudy.series.modality |
Definition | The distinct modality for this series. This may include both aquisition and non-aquisition modalities. |
Cardinality | 1..1 |
Terminology Binding | ImagingModality : |
Type | Coding |
Alternate Names | Modality |
Summary | true |
ImagingStudy.series.description | |
Element Id | ImagingStudy.series.description |
Definition | A description of the series. |
Cardinality | 0..1 |
Type | string |
Alternate Names | SeriesDescription |
Summary | true |
ImagingStudy.series.numberOfInstances | |
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. |
Cardinality | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfSeriesRelatedInstances |
Summary | true |
ImagingStudy.series.endpoint | |
Element Id | ImagingStudy.series.endpoint |
Definition | The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
Cardinality | 0..* |
Type | Reference(Endpoint) |
Requirements | Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level. |
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; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances. |
ImagingStudy.series.bodySite | |
Element Id | ImagingStudy.series.bodySite |
Definition | The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) 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. |
Cardinality | 0..1 |
Terminology Binding | SNOMED CT Body Structures (Example) |
Type | Coding |
Alternate Names | BodyPartExamined |
Summary | true |
ImagingStudy.series.laterality | |
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. |
Cardinality | 0..1 |
Terminology Binding | Bodysite Laterality (Example) |
Type | Coding |
Summary | true |
ImagingStudy.series.specimen | |
Element Id | ImagingStudy.series.specimen |
Definition | The specimen imaged, e.g., for whole slide imaging of a biopsy. |
Cardinality | 0..* |
Type | Reference(Specimen) |
Summary | true |
ImagingStudy.series.started | |
Element Id | ImagingStudy.series.started |
Definition | The date and time the series was started. |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
ImagingStudy.series.performer | |
Element Id | ImagingStudy.series.performer |
Definition | Indicates who or what performed the series and how they were involved. |
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. |
ImagingStudy.series.performer.function | |
Element Id | ImagingStudy.series.performer.function |
Definition | Distinguishes the type of involvement of the performer in the series. |
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 |
ImagingStudy.series.performer.actor | |
Element Id | ImagingStudy.series.performer.actor |
Definition | Indicates who or what performed the series. |
Cardinality | 1..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) |
Patterns | Reference(Practitioner,PractitionerRole,Organization,CareTeam,Patient,Device,RelatedPerson,HealthcareService): Common patterns = Participant |
Summary | true |
ImagingStudy.series.instance | |
Element Id | ImagingStudy.series.instance |
Definition | A single SOP instance within the series, e.g. an image, or presentation state. |
Cardinality | 0..* |
ImagingStudy.series.instance.uid | |
Element Id | ImagingStudy.series.instance.uid |
Definition | The DICOM SOP Instance UID for this image or other DICOM content. |
Cardinality | 1..1 |
Type | id |
Requirements | DICOM SOP Instance UID. |
Alternate Names | SOPInstanceUID |
Comments | See DICOM PS3.3 C.12.1 . |
ImagingStudy.series.instance.sopClass | |
Element Id | ImagingStudy.series.instance.sopClass |
Definition | DICOM instance type. |
Cardinality | 1..1 |
Terminology Binding | sopClass : |
Type | Coding |
Alternate Names | SOPClassUID |
ImagingStudy.series.instance.number | |
Element Id | ImagingStudy.series.instance.number |
Definition | The number of instance in the series. |
Cardinality | 0..1 |
Type | unsignedInt |
Alternate Names | InstanceNumber |
ImagingStudy.series.instance.title | |
Element Id | ImagingStudy.series.instance.title |
Definition | The description of the instance. |
Cardinality | 0..1 |
Type | string |
Comments | Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc. |