This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the qicore-imagingstudy Profile.
ImagingStudy(QICore-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..* |
Type | ImagingStudy |
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. Bundles always have an id, though it is usually a generated UUID. |
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 as much as possible. |
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 http://tools.ietf.org/html/bcp47 |
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. |
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 | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
ImagingStudy.extension (http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDose) | |
Definition | The range of radiation to be given for this study. |
Control | 0..1 |
Type | Extension (Extension Type: Range) |
ImagingStudy.extension (http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDuration) | |
Definition | The duration of exposure to radiation for this study. |
Control | 0..1 |
Type | Extension (Extension Type: Quantity(Duration)) |
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 | 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. |
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 |
Must Support | true |
Alternate Names | ModalitiesInStudy |
ImagingStudy.patient | |
Definition | The patient imaged in the study. |
Control | 1..1 |
Type | Reference(QICore-Patient) |
Must Support | true |
ImagingStudy.started | |
Definition | Date and Time the study started. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Alternate Names | StudyDate, StudyTime |
Example | 2011-01-01T11:01:20+03:00 |
ImagingStudy.order | |
Definition | A list of the diagnostic orders that resulted in this imaging study being performed. |
Control | 0..* |
Type | Reference(QICore-DiagnosticOrder) |
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..1 |
Type | Reference(QICore-Practitioner) |
Alternate Names | Name of Physician(s) Reading Study |
ImagingStudy.url | |
Definition | WADO-RS resource where Study is available. |
Control | 0..1 |
Type | uri |
Alternate Names | RetrieveURI |
ImagingStudy.numberOfSeries | |
Definition | Number of Series in Study. |
Control | 1..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedSeries |
ImagingStudy.numberOfInstances | |
Definition | Number of SOP Instances in Study. |
Control | 1..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedInstances |
ImagingStudy.procedure | |
Definition | Type of procedure performed. |
Control | 0..* |
Type | Reference(Procedure) |
Must Support | true |
Alternate Names | ProcedureCodeSequence |
Comments | For the Procedure.code, LOINC radiology orderables would be a good value set to use. |
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 |
ImagingStudy.series.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
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 | 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 | 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 | CT Surview 180 |
ImagingStudy.series.numberOfInstances | |
Definition | Number of SOP Instances in Series. |
Control | 1..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.url | |
Definition | URI/URL specifying the location of the referenced series using WADO-RS. |
Control | 0..1 |
Type | uri |
Alternate Names | RetrieveURI |
ImagingStudy.series.bodySite | |
Definition | Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT. |
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 | Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code. |
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.instance | |
Definition | A single SOP Instance within the series, e.g. an image, or presentation state. |
Control | 0..* |
Type | BackboneElement |
ImagingStudy.series.instance.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
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 | 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 | 1 |
ImagingStudy.series.instance.sopClass | |
Definition | DICOM instance type. |
Control | 1..1 |
Type | oid |
Alternate Names | SOPClassUID |
Example | urn:oid:1.2.840.10008.5.1.4.1.1.2 |
ImagingStudy.series.instance.type | |
Definition | A human-friendly SOP Class name. |
Control | 0..1 |
Type | string |
Comments | E.g. 'CT image', 'MR multi-frame', 'blending presentation'. |
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. |
ImagingStudy.series.instance.content | |
Definition | Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance. |
Control | 0..* |
Type | Attachment |
Comments | Use of Attachment.data is discouraged. |