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
Detailed Descriptions for the elements in the ImagingExcerpt resource.
ImagingExcerpt | |
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 have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingExcerpt 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); 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; KOS |
ImagingExcerpt.uid | |
Definition | Unique identifier of the DICOM Key Object Selection (KOS) representation. |
Control | 1..1 |
Type | oid |
Requirements | DICOM SOP Instance is always assigned with a unique identifier (UID). |
Alternate Names | SOPInstanceUID |
Summary | true |
ImagingExcerpt.patient | |
Definition | A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt. |
Control | 1..1 |
Type | Reference(Patient) |
Requirements | SOP Instances in ImagingExcerpt must be from the same patient. |
Summary | true |
Comments | SOP instances selected in the ImagingExcerpt can be from different studies, but must be of the same patient. |
ImagingExcerpt.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 |
ImagingExcerpt.author | |
Definition | Author of ImagingExcerpt. 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 |
ImagingExcerpt.title | |
Definition | The reason for, or significance of, the selection of objects referenced in the resource. |
Control | 1..1 |
Binding | KOStitle: The document title code of key object selection (Required) |
Type | CodeableConcept |
Requirements | Need to represent the application purpose that the SOP instances in ImagingExcerpt are selected for. |
Summary | true |
Comments | Coded concept of kind of the ImagingExcerpt. Value set is defined in the DICOM standard Part 16, CID-7010. |
ImagingExcerpt.description | |
Definition | Text description of the DICOM SOP instances selected in the ImagingExcerpt. 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 ImagingExcerpt. |
ImagingExcerpt.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. |
ImagingExcerpt.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 |
ImagingExcerpt.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 |
ImagingExcerpt.study.dicom | |
Definition | Methods of accessing using DICOM web technologies. |
Control | 0..* |
Requirements | access methods available using DICOM web protocols. |
Comments | Access method for applications that understand the DICOM web protocols for higher fidelity access. |
ImagingExcerpt.study.dicom.type | |
Definition | Access type for DICOM web. |
Control | 1..1 |
Binding | dWebType: The type of DICOM web technology available (Required) |
Type | code |
ImagingExcerpt.study.dicom.url | |
Definition | The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol. |
Control | 1..1 |
Type | uri |
Requirements | URL enables retrieval of the entire study using DICOM Web API. |
ImagingExcerpt.study.viewable | |
Definition | A set of viewable reference images of various types. |
Control | 0..* |
Requirements | Accessible viewable forms that can be directly pulled and displayed without knowing DICOM Web protocols. |
ImagingExcerpt.study.viewable.contentType | |
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
Control | 1..1 |
Binding | MimeType : Required: BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) (The mime type of an attachment. Any valid mime type is allowed.) |
Type | code |
Requirements | Processors of the data need to be able to know how to interpret the data. |
ImagingExcerpt.study.viewable.height | |
Definition | Height of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
ImagingExcerpt.study.viewable.width | |
Definition | Width of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
ImagingExcerpt.study.viewable.frames | |
Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. |
Control | 0..1 |
Type | positiveInt |
Default Value | 1 |
Requirements | If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. |
Comments | No relationship to the DICOM frame concept. |
ImagingExcerpt.study.viewable.duration | |
Definition | The duration of the recording in seconds - for audio and video. |
Control | 0..1 |
Type | unsignedInt |
ImagingExcerpt.study.viewable.size | |
Definition | The number of bytes of data that make up this attachment. |
Control | 0..1 |
Type | unsignedInt |
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
ImagingExcerpt.study.viewable.title | |
Definition | A label or set of text to display in place of the data. |
Control | 0..1 |
Type | string |
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
ImagingExcerpt.study.viewable.url | |
Definition | A location where the data can be accessed. |
Control | 1..1 |
Type | uri |
Requirements | The data needs to be transmitted by reference. |
ImagingExcerpt.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. |
ImagingExcerpt.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 |
ImagingExcerpt.study.series.dicom | |
Definition | Methods of accessing using DICOM web technologies. |
Control | 0..* |
Requirements | access methods available using DICOM web protocols. |
Comments | Access method for applications that understand the DICOM web protocols for higher fidelity access. |
ImagingExcerpt.study.series.dicom.type | |
Definition | Access type for DICOM web. |
Control | 1..1 |
Binding | dWebType: The type of DICOM web technology available (Required) |
Type | code |
ImagingExcerpt.study.series.dicom.url | |
Definition | The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol. |
Control | 1..1 |
Type | uri |
Requirements | URL enables retrieval of the entire series using DICOM Web API. |
ImagingExcerpt.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. |
ImagingExcerpt.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. |
ImagingExcerpt.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. |
ImagingExcerpt.study.series.instance.dicom | |
Definition | Methods of accessing using DICOM web technologies. |
Control | 0..* |
Requirements | access methods available using DICOM web protocols. |
Comments | Access method for applications that understand the DICOM web protocols for higher fidelity access. |
ImagingExcerpt.study.series.instance.dicom.type | |
Definition | Access type for DICOM web. |
Control | 1..1 |
Binding | dWebType: The type of DICOM web technology available (Required) |
Type | code |
ImagingExcerpt.study.series.instance.dicom.url | |
Definition | The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol. |
Control | 1..1 |
Type | uri |
Requirements | URL enables retrieval of the entire series using DICOM Web API. |
ImagingExcerpt.study.series.instance.frameNumbers | |
Definition | The specific frame reference within a multi-frame object. |
Control | 0..* |
Type | unsignedInt |
Requirements | The specific set of frames referenced in this imaging object selection. The URL retrieves the pixel data, and is encapsulated in a multipart MIME response. |
Comments | This component may be used if the referenced image SOP Instance is a multi-frame image. |