This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-qicore-imagingstudy Profile.
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. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
ImagingStudy.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ImagingStudy.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
ImagingStudy.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
ImagingStudy.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
ImagingStudy.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
ImagingStudy.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
ImagingStudy.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.uid | |
Definition | Formal identifier for the study. |
Control | 1..1 |
Type | oid |
Alternate Names | StudyInstanceUID |
Example | General:urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045 |
ImagingStudy.accession | |
Definition | Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance IHE Radiology Technical Framework Volume 1 Appendix A. |
Control | 0..1 |
Type | Identifier |
Alternate Names | AccessionNumber |
ImagingStudy.identifier | |
Definition | Other identifiers for the study. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Alternate Names | StudyID |
ImagingStudy.availability | |
Definition | Availability of study (online, offline, or nearline). |
Control | 0..1 |
Binding | Availability of the resource The codes SHALL be taken from InstanceAvailability |
Type | code |
Alternate Names | InstanceAvailability |
ImagingStudy.modalityList | |
Definition | A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
Control | 0..* |
Binding | Type of acquired data in the instance The codes SHALL be taken from Acquisition Modality Codes; other codes may be used where these codes are not suitable |
Type | Coding |
Alternate Names | ModalitiesInStudy |
ImagingStudy.patient | |
Definition | The patient imaged in the study. |
Control | 1..1 |
Type | Reference(QICore-Patient) |
Must Support | true |
ImagingStudy.context | |
Definition | The encounter or episode at which the request is initiated. |
Control | 0..1 |
Type | Choice of: Reference(Encounter), Reference(EpisodeOfCare) |
ImagingStudy.started | |
Definition | Date and time the study started. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Alternate Names | StudyDate, StudyTime |
Example | General:2011-01-01T19:01:20+11:00 |
ImagingStudy.basedOn | |
Definition | A list of the diagnostic requests that resulted in this imaging study being performed. |
Control | 0..* |
Type | Choice of: Reference(QICore-ReferralRequest), Reference(QICore-ProcedureRequest), Reference(CarePlan) |
Must Support | true |
Requirements | To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). |
ImagingStudy.referrer | |
Definition | The requesting/referring physician. |
Control | 0..1 |
Type | Reference(QICore-Practitioner) |
Alternate Names | ReferringPhysiciansName |
ImagingStudy.interpreter | |
Definition | Who read the study and interpreted the images or other content. |
Control | 0..* |
Type | Reference(QICore-Practitioner) |
Alternate Names | Name of Physician(s) Reading Study |
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.type. |
Control | 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. |
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 | |
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. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedSeries |
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. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedInstances |
ImagingStudy.procedureReference | |
Definition | A reference to the performed Procedure. |
Control | 0..* |
Type | Reference(QICore-Procedure) |
Must Support | true |
ImagingStudy.procedureCode | |
Definition | The code for the performed procedure type. |
Control | 0..* |
Binding | The performed procedure type For example codes, see Procedure Codes (SNOMED CT) |
Type | CodeableConcept |
Alternate Names | ProcedureCodeSequence |
ImagingStudy.reason | |
Definition | Description of clinical condition indicating why the ImagingStudy was requested. |
Control | 0..1 |
Binding | The reason for the study For example codes, see Procedure Reason Codes |
Type | CodeableConcept |
ImagingStudy.description | |
Definition | Institution-generated description or classification of the Study performed. |
Control | 0..1 |
Type | string |
Alternate Names | StudyDescription |
ImagingStudy.series | |
Definition | Each study has one or more series of images or other content. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
ImagingStudy.series.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.series.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.uid | |
Definition | Formal identifier for this series. |
Control | 1..1 |
Type | oid |
Alternate Names | SeriesInstanceUID |
Example | General:urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
ImagingStudy.series.number | |
Definition | The numeric identifier of this series in the study. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | SeriesNumber |
Example | General:3 |
ImagingStudy.series.modality | |
Definition | The modality of this series sequence. |
Control | 1..1 |
Binding | Type of acquired data in the instance The codes SHALL be taken from Acquisition Modality Codes; other codes may be used where these codes are not suitable |
Type | Coding |
Alternate Names | Modality |
ImagingStudy.series.description | |
Definition | A description of the series. |
Control | 0..1 |
Type | string |
Alternate Names | SeriesDescription |
Example | General:CT Surview 180 |
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. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | NumberOfSeriesRelatedInstances |
ImagingStudy.series.availability | |
Definition | Availability of series (online, offline or nearline). |
Control | 0..1 |
Binding | Availability of the resource The codes SHALL be taken from InstanceAvailability |
Type | code |
Alternate Names | InstanceAvailability |
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.type. |
Control | 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. |
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 | |
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. |
Control | 0..1 |
Binding | Codes describing anatomical locations. May include laterality. For example codes, see SNOMED CT Body Structures |
Type | Coding |
Alternate Names | BodyPartExamined |
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. |
Control | 0..1 |
Binding | Codes describing body site laterality (left, right, etc.). For example codes, see Laterality |
Type | Coding |
ImagingStudy.series.started | |
Definition | The date and time the series was started. |
Control | 0..1 |
Type | dateTime |
ImagingStudy.series.performer | |
Definition | The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners. |
Control | 0..* |
Type | Reference(Practitioner) |
Alternate Names | PerformingPhysicianName, OperatorName |
ImagingStudy.series.instance | |
Definition | A single SOP instance within the series, e.g. an image, or presentation state. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
ImagingStudy.series.instance.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.series.instance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.instance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.instance.uid | |
Definition | Formal identifier for this image or other content. |
Control | 1..1 |
Type | oid |
Alternate Names | SOPInstanceUID |
Example | General:urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903 |
ImagingStudy.series.instance.number | |
Definition | The number of instance in the series. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | InstanceNumber |
Example | General:1 |
ImagingStudy.series.instance.sopClass | |
Definition | DICOM instance type. |
Control | 1..1 |
Type | oid |
Alternate Names | SOPClassUID |
Example | General:urn:oid:1.2.840.10008.5.1.4.1.1.2 |
ImagingStudy.series.instance.title | |
Definition | The description of the instance. |
Control | 0..1 |
Type | string |
Comments | Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc. |