Class ImagingStudy

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class ImagingStudy
    extends DomainResource
    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.
    See Also:
    Serialized Form
    • Field Detail

      • uid

        protected OidType uid
        Formal identifier for the study.
      • accession

        protected Identifier accession
        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](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
      • modalityList

        protected List<Coding> modalityList
        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).
      • patientTarget

        protected Patient patientTarget
        The actual object that is the target of the reference (The patient imaged in the study.)
      • order

        protected List<Reference> order
        A list of the diagnostic orders that resulted in this imaging study being performed.
      • orderTarget

        protected List<DiagnosticOrder> orderTarget
        The actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.)
      • referrerTarget

        protected Practitioner referrerTarget
        The actual object that is the target of the reference (The requesting/referring physician.)
      • interpreter

        protected Reference interpreter
        Who read the study and interpreted the images or other content.
      • interpreterTarget

        protected Practitioner interpreterTarget
        The actual object that is the target of the reference (Who read the study and interpreted the images or other content.)
      • url

        protected UriType url
        WADO-RS resource where Study is available.
      • procedureTarget

        protected List<Procedure> procedureTarget
        The actual objects that are the target of the reference (Type of procedure performed.)
      • description

        protected StringType description
        Institution-generated description or classification of the Study performed.
      • SP_UID

        public static final String SP_UID
        Search parameter: uid

        Description: The instance unique identifier
        Type: uri
        Path: ImagingStudy.series.instance.uid

        See Also:
        Constant Field Values
      • UID

        public static final ca.uhn.fhir.rest.gclient.UriClientParam UID
        Fluent Client search parameter constant for uid

        Description: The instance unique identifier
        Type: uri
        Path: ImagingStudy.series.instance.uid

      • SP_SERIES

        public static final String SP_SERIES
        Search parameter: series

        Description: The identifier of the series of images
        Type: uri
        Path: ImagingStudy.series.uid

        See Also:
        Constant Field Values
      • SERIES

        public static final ca.uhn.fhir.rest.gclient.UriClientParam SERIES
        Fluent Client search parameter constant for series

        Description: The identifier of the series of images
        Type: uri
        Path: ImagingStudy.series.uid

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Who the study is about
        Type: reference
        Path: ImagingStudy.patient

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Who the study is about
        Type: reference
        Path: ImagingStudy.patient

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:patient".
      • SP_ORDER

        public static final String SP_ORDER
        Search parameter: order

        Description: The order for the image
        Type: reference
        Path: ImagingStudy.order

        See Also:
        Constant Field Values
      • ORDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORDER
        Fluent Client search parameter constant for order

        Description: The order for the image
        Type: reference
        Path: ImagingStudy.order

      • INCLUDE_ORDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:order".
      • SP_BODYSITE

        public static final String SP_BODYSITE
        Search parameter: bodysite

        Description: The body site studied
        Type: token
        Path: ImagingStudy.series.bodySite

        See Also:
        Constant Field Values
      • BODYSITE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
        Fluent Client search parameter constant for bodysite

        Description: The body site studied
        Type: token
        Path: ImagingStudy.series.bodySite

      • SP_ACCESSION

        public static final String SP_ACCESSION
        Search parameter: accession

        Description: The accession identifier for the study
        Type: token
        Path: ImagingStudy.accession

        See Also:
        Constant Field Values
      • ACCESSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
        Fluent Client search parameter constant for accession

        Description: The accession identifier for the study
        Type: token
        Path: ImagingStudy.accession

      • SP_STUDY

        public static final String SP_STUDY
        Search parameter: study

        Description: The study identifier for the image
        Type: uri
        Path: ImagingStudy.uid

        See Also:
        Constant Field Values
      • STUDY

        public static final ca.uhn.fhir.rest.gclient.UriClientParam STUDY
        Fluent Client search parameter constant for study

        Description: The study identifier for the image
        Type: uri
        Path: ImagingStudy.uid

      • SP_MODALITY

        public static final String SP_MODALITY
        Search parameter: modality

        Description: The modality of the series
        Type: token
        Path: ImagingStudy.series.modality

        See Also:
        Constant Field Values
      • MODALITY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODALITY
        Fluent Client search parameter constant for modality

        Description: The modality of the series
        Type: token
        Path: ImagingStudy.series.modality

      • SP_STARTED

        public static final String SP_STARTED
        Search parameter: started

        Description: When the study was started
        Type: date
        Path: ImagingStudy.started

        See Also:
        Constant Field Values
      • STARTED

        public static final ca.uhn.fhir.rest.gclient.DateClientParam STARTED
        Fluent Client search parameter constant for started

        Description: When the study was started
        Type: date
        Path: ImagingStudy.started

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Other identifiers for the Study
        Type: token
        Path: ImagingStudy.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Other identifiers for the Study
        Type: token
        Path: ImagingStudy.identifier

      • SP_DICOM_CLASS

        public static final String SP_DICOM_CLASS
        Search parameter: dicom-class

        Description: The type of the instance
        Type: uri
        Path: ImagingStudy.series.instance.sopClass

        See Also:
        Constant Field Values
      • DICOM_CLASS

        public static final ca.uhn.fhir.rest.gclient.UriClientParam DICOM_CLASS
        Fluent Client search parameter constant for dicom-class

        Description: The type of the instance
        Type: uri
        Path: ImagingStudy.series.instance.sopClass