Class ImagingStudy

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.ImagingStudy
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class ImagingStudy
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR ImagingStudy Resource (clinical.diagnostics)

Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/ImagingStudy

See Also:
Serialized Form
  • Field Details

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for 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

    • SP_STARTED

      public static final String SP_STARTED
      Search parameter constant for 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 constant for 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 constant for 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_SERIES

      public static final String SP_SERIES
      Search parameter constant for 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_MODALITY

      public static final String SP_MODALITY
      Search parameter constant for 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 constant for 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_UID

      public static final String SP_UID
      Search parameter constant for 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_DICOM_CLASS

      public static final String SP_DICOM_CLASS
      Search parameter constant for 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_ORDER

      public static final String SP_ORDER
      Search parameter constant for 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".
    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getStartedElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getStartedElement()
      Gets the value(s) for started (when.init). creating it if it does not exist. Will not return null.

      Definition: Date and Time the study started

    • getStarted

      public Date getStarted()
      Gets the value(s) for started (when.init). creating it if it does not exist. This method may return null.

      Definition: Date and Time the study started

    • setStarted

      public ImagingStudy setStarted​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for started (when.init)

      Definition: Date and Time the study started

    • setStarted

      public ImagingStudy setStarted​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for started (when.init)

      Definition: Date and Time the study started

    • setStartedWithSecondsPrecision

      Sets the value for started (when.init)

      Definition: Date and Time the study started

    • getPatient

      Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

      Definition: The patient imaged in the study.

    • setPatient

      Sets the value(s) for patient (who.focus)

      Definition: The patient imaged in the study.

    • getUidElement

      public ca.uhn.fhir.model.primitive.OidDt getUidElement()
      Gets the value(s) for uid (id). creating it if it does not exist. Will not return null.

      Definition: Formal identifier for the study

    • getUid

      public String getUid()
      Gets the value(s) for uid (id). creating it if it does not exist. This method may return null.

      Definition: Formal identifier for the study

    • setUid

      public ImagingStudy setUid​(ca.uhn.fhir.model.primitive.OidDt theValue)
      Sets the value(s) for uid (id)

      Definition: Formal identifier for the study

    • getAccession

      Gets the value(s) for accession (id). creating it if it does not exist. Will not return null.

      Definition: 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)

    • setAccession

      public ImagingStudy setAccession​(IdentifierDt theValue)
      Sets the value(s) for accession (id)

      Definition: 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)

    • getIdentifier

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: Other identifiers for the study

    • setIdentifier

      Sets the value(s) for identifier (id)

      Definition: Other identifiers for the study

    • addIdentifier

      Adds and returns a new value for identifier (id)

      Definition: Other identifiers for the study

    • addIdentifier

      public ImagingStudy addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: Other identifiers for the study

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: Other identifiers for the study

    • getOrder

      Gets the value(s) for order (). creating it if it does not exist. Will not return null.

      Definition: A list of the diagnostic orders that resulted in this imaging study being performed

    • setOrder

      Sets the value(s) for order ()

      Definition: A list of the diagnostic orders that resulted in this imaging study being performed

    • addOrder

      Adds and returns a new value for order ()

      Definition: A list of the diagnostic orders that resulted in this imaging study being performed

    • getModalityList

      Gets the value(s) for modalityList (class). creating it if it does not exist. Will not return null.

      Definition: 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)

    • setModalityList

      public ImagingStudy setModalityList​(List<CodingDt> theValue)
      Sets the value(s) for modalityList (class)

      Definition: 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)

    • addModalityList

      Adds and returns a new value for modalityList (class)

      Definition: 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)

    • addModalityList

      public ImagingStudy addModalityList​(CodingDt theValue)
      Adds a given new value for modalityList (class)

      Definition: 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)

      Parameters:
      theValue - The modalityList to add (must not be null)
    • getModalityListFirstRep

      Gets the first repetition for modalityList (class), creating it if it does not already exist.

      Definition: 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)

    • getReferrer

      Gets the value(s) for referrer (who.cause). creating it if it does not exist. Will not return null.

      Definition: The requesting/referring physician

    • setReferrer

      Sets the value(s) for referrer (who.cause)

      Definition: The requesting/referring physician

    • getAvailabilityElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<InstanceAvailabilityEnum> getAvailabilityElement()
      Gets the value(s) for availability (status). creating it if it does not exist. Will not return null.

      Definition: Availability of study (online, offline or nearline)

    • getAvailability

      Gets the value(s) for availability (status). creating it if it does not exist. This method may return null.

      Definition: Availability of study (online, offline or nearline)

    • setAvailability

      public ImagingStudy setAvailability​(ca.uhn.fhir.model.primitive.BoundCodeDt<InstanceAvailabilityEnum> theValue)
      Sets the value(s) for availability (status)

      Definition: Availability of study (online, offline or nearline)

    • setAvailability

      Sets the value(s) for availability (status)

      Definition: Availability of study (online, offline or nearline)

    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (). creating it if it does not exist. Will not return null.

      Definition: WADO-RS resource where Study is available.

    • getUrl

      public String getUrl()
      Gets the value(s) for url (). creating it if it does not exist. This method may return null.

      Definition: WADO-RS resource where Study is available.

    • setUrl

      public ImagingStudy setUrl​(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for url ()

      Definition: WADO-RS resource where Study is available.

    • setUrl

      public ImagingStudy setUrl​(String theUri)
      Sets the value for url ()

      Definition: WADO-RS resource where Study is available.

    • getNumberOfSeriesElement

      public ca.uhn.fhir.model.primitive.UnsignedIntDt getNumberOfSeriesElement()
      Gets the value(s) for numberOfSeries (). creating it if it does not exist. Will not return null.

      Definition: Number of Series in Study

    • getNumberOfSeries

      Gets the value(s) for numberOfSeries (). creating it if it does not exist. This method may return null.

      Definition: Number of Series in Study

    • setNumberOfSeries

      public ImagingStudy setNumberOfSeries​(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
      Sets the value(s) for numberOfSeries ()

      Definition: Number of Series in Study

    • setNumberOfSeries

      public ImagingStudy setNumberOfSeries​(int theInteger)
      Sets the value for numberOfSeries ()

      Definition: Number of Series in Study

    • getNumberOfInstancesElement

      public ca.uhn.fhir.model.primitive.UnsignedIntDt getNumberOfInstancesElement()
      Gets the value(s) for numberOfInstances (). creating it if it does not exist. Will not return null.

      Definition: Number of SOP Instances in Study

    • getNumberOfInstances

      Gets the value(s) for numberOfInstances (). creating it if it does not exist. This method may return null.

      Definition: Number of SOP Instances in Study

    • setNumberOfInstances

      public ImagingStudy setNumberOfInstances​(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
      Sets the value(s) for numberOfInstances ()

      Definition: Number of SOP Instances in Study

    • setNumberOfInstances

      public ImagingStudy setNumberOfInstances​(int theInteger)
      Sets the value for numberOfInstances ()

      Definition: Number of SOP Instances in Study

    • getProcedure

      Gets the value(s) for procedure (). creating it if it does not exist. Will not return null.

      Definition: Type of procedure performed

    • setProcedure

      Sets the value(s) for procedure ()

      Definition: Type of procedure performed

    • addProcedure

      Adds and returns a new value for procedure ()

      Definition: Type of procedure performed

    • getInterpreter

      Gets the value(s) for interpreter (who.witness). creating it if it does not exist. Will not return null.

      Definition: Who read the study and interpreted the images or other content

    • setInterpreter

      Sets the value(s) for interpreter (who.witness)

      Definition: Who read the study and interpreted the images or other content

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: Institution-generated description or classification of the Study performed

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: Institution-generated description or classification of the Study performed

    • setDescription

      public ImagingStudy setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: Institution-generated description or classification of the Study performed

    • setDescription

      public ImagingStudy setDescription​(String theString)
      Sets the value for description ()

      Definition: Institution-generated description or classification of the Study performed

    • getSeries

      Gets the value(s) for series (). creating it if it does not exist. Will not return null.

      Definition: Each study has one or more series of images or other content

    • setSeries

      Sets the value(s) for series ()

      Definition: Each study has one or more series of images or other content

    • addSeries

      Adds and returns a new value for series ()

      Definition: Each study has one or more series of images or other content

    • addSeries

      Adds a given new value for series ()

      Definition: Each study has one or more series of images or other content

      Parameters:
      theValue - The series to add (must not be null)
    • getSeriesFirstRep

      Gets the first repetition for series (), creating it if it does not already exist.

      Definition: Each study has one or more series of images or other content

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource