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 Details

    • 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).
    • identifier

      Other identifiers for the study.
    • availability

      Availability of study (online, offline, or nearline).
    • 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).
    • patient

      protected Reference patient
      The patient imaged in the study.
    • patientTarget

      The actual object that is the target of the reference (The patient imaged in the study.)
    • context

      protected Reference context
      The encounter or episode at which the request is initiated.
    • contextTarget

      The actual object that is the target of the reference (The encounter or episode at which the request is initiated.)
    • started

      protected DateTimeType started
      Date and time the study started.
    • basedOn

      protected List<Reference> basedOn
      A list of the diagnostic requests that resulted in this imaging study being performed.
    • basedOnTarget

      The actual objects that are the target of the reference (A list of the diagnostic requests that resulted in this imaging study being performed.)
    • referrer

      protected Reference referrer
      The requesting/referring physician.
    • referrerTarget

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

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

      The actual objects that are the target of the reference (Who read the study and interpreted the images or other content.)
    • endpoint

      protected List<Reference> endpoint
      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.
    • endpointTarget

      The actual objects that are the target of the reference (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.)
    • numberOfSeries

      Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
    • numberOfInstances

      Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
    • procedureReference

      A reference to the performed Procedure.
    • procedureReferenceTarget

      The actual objects that are the target of the reference (A reference to the performed Procedure.)
    • procedureCode

      The code for the performed procedure type.
    • reason

      Description of clinical condition indicating why the ImagingStudy was requested.
    • description

      Institution-generated description or classification of the Study performed.
    • series

      Each study has one or more series of images or other content.
    • 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_REASON

      public static final String SP_REASON
      Search parameter: reason

      Description: The reason for the study
      Type: token
      Path: ImagingStudy.reason

      See Also:
      Constant Field Values
    • REASON

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

      Description: The reason for the study
      Type: token
      Path: ImagingStudy.reason

    • 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_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

    • 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_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_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: The person who performed the study
      Type: reference
      Path: ImagingStudy.series.performer

      See Also:
      Constant Field Values
    • PERFORMER

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

      Description: The person who performed the study
      Type: reference
      Path: ImagingStudy.series.performer

    • INCLUDE_PERFORMER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:performer".
    • 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_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_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_ENDPOINT

      public static final String SP_ENDPOINT
      Search parameter: endpoint

      Description: The endpoint for te study or series
      Type: reference
      Path: ImagingStudy.endpoint, ImagingStudy.series.endpoint

      See Also:
      Constant Field Values
    • ENDPOINT

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

      Description: The endpoint for te study or series
      Type: reference
      Path: ImagingStudy.endpoint, ImagingStudy.series.endpoint

    • INCLUDE_ENDPOINT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:endpoint".
    • 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_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_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: The context of the study
      Type: reference
      Path: ImagingStudy.context

      See Also:
      Constant Field Values
    • CONTEXT

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

      Description: The context of the study
      Type: reference
      Path: ImagingStudy.context

    • INCLUDE_CONTEXT

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

      public static final String SP_BASEDON
      Search parameter: basedon

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

      See Also:
      Constant Field Values
    • BASEDON

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

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

    • INCLUDE_BASEDON

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

  • Method Details