FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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

Imaging Integration Work GroupMaturity Level: 1 Trial UseCompartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the ImagingManifest resource.

ImagingManifest
Definition

A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.

Control1..1
Alternate NamesManifest; XDS-I summary; Key Images; (in limited use) Key Object Selection (KOS)
ImagingManifest.identifier
Definition

Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Requirements

DICOM SOP Instance is always assigned with a unique identifier (UID).

Alternate NamesSOPInstanceUID
Summarytrue
ImagingManifest.patient
Definition

A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.

Control1..1
TypeReference(Patient)
Requirements

SOP Instances in ImagingManifest must be from the same patient.

Summarytrue
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).

Control0..1
TypedateTime
Requirements

Date and time when the selection was made can be important to understand the content of selection.

Alternate NamesObservationDateTime
Summarytrue
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.

Control0..1
TypeReference(Practitioner | Device | Organization | Patient | RelatedPerson)
Requirements

Track the selection decision maker.

Summarytrue
ImagingManifest.description
Definition

Free text narrative description of the ImagingManifest.
The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.

Control0..1
Typestring
Requirements

Need to provide a narrative description of the SOP instances in the selection.

Alternate NamesTextValue
Summarytrue
Comments

Free text narrative description of the ImagingManifest.

ImagingManifest.study
Definition

Study identity and locating information of the DICOM SOP instances in the selection.

Control1..*
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.

Summarytrue
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 hierarchical identification of the instances.

ImagingManifest.study.uid
Definition

Study instance UID of the SOP instances in the selection.

Control1..1
Typeoid
Requirements

Study instance UID is required to fully identify the DICOM SOP instances in the selection.

Alternate NamesStudyInstanceUID; Referenced study instance UID
Summarytrue
ImagingManifest.study.imagingStudy
Definition

Reference to the Imaging Study in FHIR form.

Control0..1
TypeReference(ImagingStudy)
Requirements

Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study.

Summarytrue
ImagingManifest.study.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.

Control0..*
TypeReference(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.

Summarytrue
ImagingManifest.study.series
Definition

Series identity and locating information of the DICOM SOP instances in the selection.

Control1..*
Requirements

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provides a means of retrieving the entire series.

Summarytrue
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.

Control1..1
Typeoid
Requirements

Series instance UID is required to fully identify the DICOM SOP instances in the selection.

Alternate NamesSeriesInstanceUID; Referenced series instance UID
Summarytrue
ImagingManifest.study.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.

Control0..*
TypeReference(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.

Summarytrue
ImagingManifest.study.series.instance
Definition

Identity and locating information of the selected DICOM SOP instances.

Control1..*
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.

Summarytrue
Comments

SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierarchy.

ImagingManifest.study.series.instance.sopClass
Definition

SOP class UID of the selected instance.

Control1..1
Typeoid
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 NamesSOPClassUID
Summarytrue
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.

Control1..1
Typeoid
Requirements

SOP instance UID is required to fully identify the DICOM SOP instance in the selection.

Alternate NamesSOPInstanceUID; Referenced SOP instance UID
Summarytrue
Comments

SOP instance UID identifies the instance.