This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Detailed Descriptions for the elements in the ImagingManifest resource.
ImagingManifest | |
Definition | A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances may have been selected for a purpose, such as conference, or consult. Reflecting a range of sharing purposes, typical ImagingManifest resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); both a multi-frame ultrasound instance ("cine" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on. |
Control | 1..1 |
Requirements | A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances. |
Alternate Names | Manifest; XDS-I summary; Key Images; (in limited use) Key Object Selection (KOS) |
ImagingManifest.uid | |
Definition | Unique identifier of the the DICOM Key Object Selection (KOS) that this resource represents. |
Control | 0..1 |
Type | oid |
Requirements | DICOM SOP Instance is always assigned with a unique identifier (UID). |
Alternate Names | SOPInstanceUID |
Summary | true |
ImagingManifest.patient | |
Definition | A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest. |
Control | 1..1 |
Type | Reference(Patient) |
Requirements | SOP Instances in ImagingManifest must be from the same patient. |
Summary | true |
Comments | SOP instances selected in the ImagingManifest can be from different studies, but must be of the same patient. |
ImagingManifest.authoringTime | |
Definition | Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image). |
Control | 0..1 |
Type | dateTime |
Requirements | Date and time when the selection was made can be important to understand the content of selection. |
Alternate Names | ObservationDateTime |
Summary | true |
ImagingManifest.author | |
Definition | Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion. |
Control | 0..1 |
Type | Reference(Practitioner | Device | Organization | Patient | RelatedPerson) |
Requirements | Track the selection decision maker. |
Summary | true |
ImagingManifest.title | |
Definition | The reason for, or significance of, the selection of objects referenced in the resource. |
Control | 1..1 |
Terminology Binding | KOStitle (Required) |
Type | CodeableConcept |
Requirements | Need to represent the application purpose that the SOP instances in ImagingManifest are selected for. |
Summary | true |
Comments | Value set is a subset of DICOM Standard Part 16, CID-7010. Common values are 113013 (Best in Set), 113000 (Of Interest), 113032 (Complete Study Content). The title value chosen may suggest whether the ImagingManifest references full study content, or only highlights. A DICOM Key Object Selection has a wide range of uses, indicated by the KOS title. Certain titles indicate that the referenced images should be removed or not used; ImagingManifest is not intended to support those uses. |
ImagingManifest.description | |
Definition | Text description of the DICOM SOP instances selected in the ImagingManifest. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection. |
Control | 0..1 |
Type | string |
Requirements | Need to provide a narrative description of the SOP instances in the selection. |
Alternate Names | TextValue |
Summary | true |
Comments | Free text narrative description of the ImagingManifest. |
ImagingManifest.study | |
Definition | Study identity and locating information of the DICOM SOP instances in the selection. |
Control | 1..* |
Requirements | DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study. |
Summary | true |
Comments | Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances. |
ImagingManifest.study.uid | |
Definition | Study instance UID of the SOP instances in the selection. |
Control | 1..1 |
Type | oid |
Requirements | Study instance UID is required to fully identify the DICOM SOP instances in the selection. |
Alternate Names | StudyInstanceUID; Referenced study instance UID |
Summary | true |
ImagingManifest.study.imagingStudy | |
Definition | Reference to the Imaging Study in FHIR form. |
Control | 0..1 |
Type | Reference(ImagingStudy) |
Requirements | Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study. |
Summary | true |
ImagingManifest.study.baseLocation | |
Definition | Methods of accessing (e.g., retrieving, viewing) the study. |
Control | 0..* |
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. |
To Do | likely change to Endpoint Resource reference. |
ImagingManifest.study.baseLocation.type | |
Definition | The service type for accessing (e.g., retrieving, viewing) the DICOM instances. |
Control | 1..1 |
Terminology Binding | dWebType (Extensible) |
Type | Coding |
ImagingManifest.study.baseLocation.url | |
Definition | The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.baseLocation.type. |
Control | 1..1 |
Type | uri |
Comments | This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to view, retrieve, or otherwise access the study or the study’s series or instances. For example, this element may be a DICOMweb WADO-RS endpoint. |
ImagingManifest.study.series | |
Definition | Series identity and locating information of the DICOM SOP instances in the selection. |
Control | 1..* |
Requirements | DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series. |
Summary | true |
Comments | Series component represents the series level identity and locator information of the DICOM SOP instances in the selection. |
ImagingManifest.study.series.uid | |
Definition | Series instance UID of the SOP instances in the selection. |
Control | 1..1 |
Type | oid |
Requirements | Series instance UID is required to fully identify the DICOM SOP instances in the selection. |
Alternate Names | SeriesInstanceUID; Referenced series instance UID |
Summary | true |
ImagingManifest.study.series.baseLocation | |
Definition | Methods of accessing (e.g. retrieving) the series. |
Control | 0..* |
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. |
To Do | likely change to Endpoint Resource reference. |
ImagingManifest.study.series.baseLocation.type | |
Definition | The service type for accessing (e.g., retrieving) the DICOM instances. |
Control | 1..1 |
Terminology Binding | dWebType (Extensible) |
Type | Coding |
ImagingManifest.study.series.baseLocation.url | |
Definition | The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.series.baseLocation.type. |
Control | 1..1 |
Type | uri |
Comments | This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.series.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to retrieve, or otherwise access, the series or the series’ instances. For example, this element may be a DICOMweb WADO-RS endpoint. |
ImagingManifest.study.series.instance | |
Definition | Identity and locating information of the selected DICOM SOP instances. |
Control | 1..* |
Requirements | DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection. |
Summary | true |
Comments | SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierachy. |
ImagingManifest.study.series.instance.sopClass | |
Definition | SOP class UID of the selected instance. |
Control | 1..1 |
Type | oid |
Requirements | DICOM SOP instances can be an image or other data object. The SOP class UID provide the accurate information about what type the instance is. |
Alternate Names | SOPClassUID |
Summary | true |
Comments | SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc. |
ImagingManifest.study.series.instance.uid | |
Definition | SOP Instance UID of the selected instance. |
Control | 1..1 |
Type | oid |
Requirements | SOP instance UID is required to fully identify the DICOM SOP instance in the selection. |
Alternate Names | SOPInstanceUID; Referenced SOP instance UID |
Summary | true |
Comments | SOP instance UID identifies the instance. |