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

      • identifier

        protected List<Identifier> identifier
        Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
      • modality

        protected List<Coding> modality
        A list of all the series.modality 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).
      • subject

        protected Reference subject
        The subject, typically a patient, of the imaging study.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (The subject, typically a patient, of the imaging study.)
      • encounter

        protected Reference encounter
        The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)
      • basedOn

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

        protected List<Resource> 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.)
      • referrerTarget

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

        protected List<Resource> 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.connectionType.
      • endpointTarget

        protected List<Endpoint> 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.connectionType.)
      • numberOfSeries

        protected UnsignedIntType 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

        protected UnsignedIntType 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.
      • procedureReferenceTarget

        protected Procedure procedureReferenceTarget
        The actual object that is the target of the reference (The procedure which this ImagingStudy was part of.)
      • location

        protected Reference location
        The principal physical location where the ImagingStudy was performed.
      • locationTarget

        protected Location locationTarget
        The actual object that is the target of the reference (The principal physical location where the ImagingStudy was performed.)
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Indicates another resource whose existence justifies this Study.)
      • note

        protected List<Annotation> note
        Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
      • description

        protected StringType description
        The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Identifiers for the Study, such as DICOM Study Instance UID and Accession number
        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: Identifiers for the Study, such as DICOM Study Instance UID and Accession number
        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.reasonCode

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

      • SP_DICOM_CLASS

        public static final String SP_DICOM_CLASS
        Search parameter: dicom-class

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

        See Also:
        Constant Field Values
      • DICOM_CLASS

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

        Description: The type of the instance
        Type: token
        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_INSTANCE

        public static final String SP_INSTANCE
        Search parameter: instance

        Description: SOP Instance UID for an instance
        Type: token
        Path: ImagingStudy.series.instance.uid

        See Also:
        Constant Field Values
      • INSTANCE

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

        Description: SOP Instance UID for an instance
        Type: token
        Path: ImagingStudy.series.instance.uid

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: performer

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

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

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

        public static final String SP_SUBJECT
        Search parameter: subject

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

        See Also:
        Constant Field Values
      • SUBJECT

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

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

      • INCLUDE_SUBJECT

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

        public static final String SP_INTERPRETER
        Search parameter: interpreter

        Description: Who interpreted the images
        Type: reference
        Path: ImagingStudy.interpreter

        See Also:
        Constant Field Values
      • INTERPRETER

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

        Description: Who interpreted the images
        Type: reference
        Path: ImagingStudy.interpreter

      • INCLUDE_INTERPRETER

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

        public static final String SP_ENCOUNTER
        Search parameter: encounter

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

        See Also:
        Constant Field Values
      • ENCOUNTER

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

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

      • INCLUDE_ENCOUNTER

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

        public static final String SP_REFERRER
        Search parameter: referrer

        Description: The referring physician
        Type: reference
        Path: ImagingStudy.referrer

        See Also:
        Constant Field Values
      • REFERRER

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

        Description: The referring physician
        Type: reference
        Path: ImagingStudy.referrer

      • INCLUDE_REFERRER

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

        public static final String SP_ENDPOINT
        Search parameter: endpoint

        Description: The endpoint for the 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 the 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.subject

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

      • 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: DICOM Series Instance UID for a series
        Type: token
        Path: ImagingStudy.series.uid

        See Also:
        Constant Field Values
      • SERIES

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

        Description: DICOM Series Instance UID for a series
        Type: token
        Path: ImagingStudy.series.uid

      • 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".
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The status of the study
        Type: token
        Path: ImagingStudy.status

        See Also:
        Constant Field Values
      • STATUS

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

        Description: The status of the study
        Type: token
        Path: ImagingStudy.status