
Class 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
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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImagingStudy.Series
Block class for child element: ImagingStudy.series ()static class
ImagingStudy.SeriesInstance
Block class for child element: ImagingStudy.series.instance () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
ACCESSION
Fluent Client search parameter constant for accessionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
BODYSITE
Fluent Client search parameter constant for bodysitestatic ca.uhn.fhir.rest.gclient.UriClientParam
DICOM_CLASS
Fluent Client search parameter constant for dicom-classstatic ca.uhn.fhir.model.api.Include
INCLUDE_ORDER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParam
MODALITY
Fluent Client search parameter constant for modalitystatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
ORDER
Fluent Client search parameter constant for orderstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.UriClientParam
SERIES
Fluent Client search parameter constant for seriesstatic String
SP_ACCESSION
Search parameter constant for accessionstatic String
SP_BODYSITE
Search parameter constant for bodysitestatic String
SP_DICOM_CLASS
Search parameter constant for dicom-classstatic String
SP_MODALITY
Search parameter constant for modalitystatic String
SP_ORDER
Search parameter constant for orderstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_SERIES
Search parameter constant for seriesstatic String
SP_STARTED
Search parameter constant for startedstatic String
SP_STUDY
Search parameter constant for studystatic String
SP_UID
Search parameter constant for uidstatic ca.uhn.fhir.rest.gclient.DateClientParam
STARTED
Fluent Client search parameter constant for startedstatic ca.uhn.fhir.rest.gclient.UriClientParam
STUDY
Fluent Client search parameter constant for studystatic ca.uhn.fhir.rest.gclient.UriClientParam
UID
Fluent Client search parameter constant for uidFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description ImagingStudy()
-
Method Summary
Modifier and Type Method Description IdentifierDt
addIdentifier()
Adds and returns a new value for identifier (id)ImagingStudy
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)CodingDt
addModalityList()
Adds and returns a new value for modalityList (class)ImagingStudy
addModalityList(CodingDt theValue)
Adds a given new value for modalityList (class)ResourceReferenceDt
addOrder()
Adds and returns a new value for order ()ResourceReferenceDt
addProcedure()
Adds and returns a new value for procedure ()ImagingStudy.Series
addSeries()
Adds and returns a new value for series ()ImagingStudy
addSeries(ImagingStudy.Series theValue)
Adds a given new value for series ()IdentifierDt
getAccession()
Gets the value(s) for accession (id).<T extends ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
String
getAvailability()
Gets the value(s) for availability (status).ca.uhn.fhir.model.primitive.BoundCodeDt<InstanceAvailabilityEnum>
getAvailabilityElement()
Gets the value(s) for availability (status).String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.StringDt
getDescriptionElement()
Gets the value(s) for description ().List<IdentifierDt>
getIdentifier()
Gets the value(s) for identifier (id).IdentifierDt
getIdentifierFirstRep()
Gets the first repetition for identifier (id), creating it if it does not already exist.ResourceReferenceDt
getInterpreter()
Gets the value(s) for interpreter (who.witness).List<CodingDt>
getModalityList()
Gets the value(s) for modalityList (class).CodingDt
getModalityListFirstRep()
Gets the first repetition for modalityList (class), creating it if it does not already exist.Integer
getNumberOfInstances()
Gets the value(s) for numberOfInstances ().ca.uhn.fhir.model.primitive.UnsignedIntDt
getNumberOfInstancesElement()
Gets the value(s) for numberOfInstances ().Integer
getNumberOfSeries()
Gets the value(s) for numberOfSeries ().ca.uhn.fhir.model.primitive.UnsignedIntDt
getNumberOfSeriesElement()
Gets the value(s) for numberOfSeries ().List<ResourceReferenceDt>
getOrder()
Gets the value(s) for order ().ResourceReferenceDt
getPatient()
Gets the value(s) for patient (who.focus).List<ResourceReferenceDt>
getProcedure()
Gets the value(s) for procedure ().ResourceReferenceDt
getReferrer()
Gets the value(s) for referrer (who.cause).String
getResourceName()
List<ImagingStudy.Series>
getSeries()
Gets the value(s) for series ().ImagingStudy.Series
getSeriesFirstRep()
Gets the first repetition for series (), creating it if it does not already exist.Date
getStarted()
Gets the value(s) for started (when.init).ca.uhn.fhir.model.primitive.DateTimeDt
getStartedElement()
Gets the value(s) for started (when.init).ca.uhn.fhir.context.FhirVersionEnum
getStructureFhirVersionEnum()
String
getUid()
Gets the value(s) for uid (id).ca.uhn.fhir.model.primitive.OidDt
getUidElement()
Gets the value(s) for uid (id).String
getUrl()
Gets the value(s) for url ().ca.uhn.fhir.model.primitive.UriDt
getUrlElement()
Gets the value(s) for url ().boolean
isEmpty()
ImagingStudy
setAccession(IdentifierDt theValue)
Sets the value(s) for accession (id)ImagingStudy
setAvailability(InstanceAvailabilityEnum theValue)
Sets the value(s) for availability (status)ImagingStudy
setAvailability(ca.uhn.fhir.model.primitive.BoundCodeDt<InstanceAvailabilityEnum> theValue)
Sets the value(s) for availability (status)ImagingStudy
setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()ImagingStudy
setDescription(String theString)
Sets the value for description ()ImagingStudy
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)ImagingStudy
setInterpreter(ResourceReferenceDt theValue)
Sets the value(s) for interpreter (who.witness)ImagingStudy
setModalityList(List<CodingDt> theValue)
Sets the value(s) for modalityList (class)ImagingStudy
setNumberOfInstances(int theInteger)
Sets the value for numberOfInstances ()ImagingStudy
setNumberOfInstances(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
Sets the value(s) for numberOfInstances ()ImagingStudy
setNumberOfSeries(int theInteger)
Sets the value for numberOfSeries ()ImagingStudy
setNumberOfSeries(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
Sets the value(s) for numberOfSeries ()ImagingStudy
setOrder(List<ResourceReferenceDt> theValue)
Sets the value(s) for order ()ImagingStudy
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient (who.focus)ImagingStudy
setProcedure(List<ResourceReferenceDt> theValue)
Sets the value(s) for procedure ()ImagingStudy
setReferrer(ResourceReferenceDt theValue)
Sets the value(s) for referrer (who.cause)ImagingStudy
setSeries(List<ImagingStudy.Series> theValue)
Sets the value(s) for series ()ImagingStudy
setStarted(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
Sets the value(s) for started (when.init)ImagingStudy
setStarted(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for started (when.init)ImagingStudy
setStartedWithSecondsPrecision(Date theDate)
Sets the value for started (when.init)ImagingStudy
setUid(ca.uhn.fhir.model.primitive.OidDt theValue)
Sets the value(s) for uid (id)ImagingStudy
setUrl(ca.uhn.fhir.model.primitive.UriDt theValue)
Sets the value(s) for url ()ImagingStudy
setUrl(String theUri)
Sets the value for url ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_PATIENT
Search parameter constant for patientDescription: Who the study is about
Type: reference
Path: ImagingStudy.patient
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who the study is about
Type: reference
Path: ImagingStudy.patient
-
SP_STARTED
Search parameter constant for startedDescription: When the study was started
Type: date
Path: ImagingStudy.started
- See Also:
- Constant Field Values
-
STARTED
Fluent Client search parameter constant for startedDescription: When the study was started
Type: date
Path: ImagingStudy.started
-
SP_ACCESSION
Search parameter constant for accessionDescription: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
- See Also:
- Constant Field Values
-
ACCESSION
Fluent Client search parameter constant for accessionDescription: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
-
SP_STUDY
Search parameter constant for studyDescription: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
- See Also:
- Constant Field Values
-
STUDY
Fluent Client search parameter constant for studyDescription: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
-
SP_SERIES
Search parameter constant for seriesDescription: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
- See Also:
- Constant Field Values
-
SERIES
Fluent Client search parameter constant for seriesDescription: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
-
SP_MODALITY
Search parameter constant for modalityDescription: The modality of the series
Type: token
Path: ImagingStudy.series.modality
- See Also:
- Constant Field Values
-
MODALITY
Fluent Client search parameter constant for modalityDescription: The modality of the series
Type: token
Path: ImagingStudy.series.modality
-
SP_BODYSITE
Search parameter constant for bodysiteDescription: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
- See Also:
- Constant Field Values
-
BODYSITE
Fluent Client search parameter constant for bodysiteDescription: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
-
SP_UID
Search parameter constant for uidDescription: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
- See Also:
- Constant Field Values
-
UID
Fluent Client search parameter constant for uidDescription: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
-
SP_DICOM_CLASS
Search parameter constant for dicom-classDescription: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
- See Also:
- Constant Field Values
-
DICOM_CLASS
Fluent Client search parameter constant for dicom-classDescription: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
-
SP_ORDER
Search parameter constant for orderDescription: The order for the image
Type: reference
Path: ImagingStudy.order
- See Also:
- Constant Field Values
-
ORDER
Fluent Client search parameter constant for orderDescription: The order for the image
Type: reference
Path: ImagingStudy.order
-
INCLUDE_ORDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:order". -
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:patient".
-
-
Constructor Details
-
ImagingStudy
public ImagingStudy()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.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 interfaceca.uhn.fhir.model.api.ICompositeElement
-
getStartedElement
Gets the value(s) for started (when.init). creating it if it does not exist. Will not returnnull
.Definition: Date and Time the study started
-
getStarted
Gets the value(s) for started (when.init). creating it if it does not exist. This method may returnnull
.Definition: Date and Time the study started
-
setStarted
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 returnnull
.Definition: The patient imaged in the study.
-
setPatient
Sets the value(s) for patient (who.focus)Definition: The patient imaged in the study.
-
getUidElement
Gets the value(s) for uid (id). creating it if it does not exist. Will not returnnull
.Definition: Formal identifier for the study
-
getUid
Gets the value(s) for uid (id). creating it if it does not exist. This method may returnnull
.Definition: Formal identifier for the study
-
setUid
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 returnnull
.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
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 returnnull
.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
Adds a given new value for identifier (id)Definition: Other identifiers for the study
- Parameters:
theValue
- The identifier to add (must not benull
)
-
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 returnnull
.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 returnnull
.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
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
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 benull
)
-
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 returnnull
.Definition: The requesting/referring physician
-
setReferrer
Sets the value(s) for referrer (who.cause)Definition: The requesting/referring physician
-
getAvailabilityElement
Gets the value(s) for availability (status). creating it if it does not exist. Will not returnnull
.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 returnnull
.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
Gets the value(s) for url (). creating it if it does not exist. Will not returnnull
.Definition: WADO-RS resource where Study is available.
-
getUrl
Gets the value(s) for url (). creating it if it does not exist. This method may returnnull
.Definition: WADO-RS resource where Study is available.
-
setUrl
Sets the value(s) for url ()Definition: WADO-RS resource where Study is available.
-
setUrl
Sets the value for url ()Definition: WADO-RS resource where Study is available.
-
getNumberOfSeriesElement
Gets the value(s) for numberOfSeries (). creating it if it does not exist. Will not returnnull
.Definition: Number of Series in Study
-
getNumberOfSeries
Gets the value(s) for numberOfSeries (). creating it if it does not exist. This method may returnnull
.Definition: Number of Series in Study
-
setNumberOfSeries
Sets the value(s) for numberOfSeries ()Definition: Number of Series in Study
-
setNumberOfSeries
Sets the value for numberOfSeries ()Definition: Number of Series in Study
-
getNumberOfInstancesElement
Gets the value(s) for numberOfInstances (). creating it if it does not exist. Will not returnnull
.Definition: Number of SOP Instances in Study
-
getNumberOfInstances
Gets the value(s) for numberOfInstances (). creating it if it does not exist. This method may returnnull
.Definition: Number of SOP Instances in Study
-
setNumberOfInstances
Sets the value(s) for numberOfInstances ()Definition: Number of SOP Instances in Study
-
setNumberOfInstances
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 returnnull
.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 returnnull
.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
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.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 returnnull
.Definition: Institution-generated description or classification of the Study performed
-
setDescription
Sets the value(s) for description ()Definition: Institution-generated description or classification of the Study performed
-
setDescription
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 returnnull
.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 benull
)
-
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 interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-