public class ImagingStudy extends BaseResource implements 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
| Modifier and Type | Class and Description |
|---|---|
static class |
ImagingStudy.Series
Block class for child element: ImagingStudy.series ()
|
static class |
ImagingStudy.SeriesInstance
Block class for child element: ImagingStudy.series.instance ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
ACCESSION
Fluent Client search parameter constant for accession
|
static TokenClientParam |
BODYSITE
Fluent Client search parameter constant for bodysite
|
static UriClientParam |
DICOM_CLASS
Fluent Client search parameter constant for dicom-class
|
static Include |
INCLUDE_ORDER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
MODALITY
Fluent Client search parameter constant for modality
|
static ReferenceClientParam |
ORDER
Fluent Client search parameter constant for order
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static UriClientParam |
SERIES
Fluent Client search parameter constant for series
|
static String |
SP_ACCESSION
Search parameter constant for accession
|
static String |
SP_BODYSITE
Search parameter constant for bodysite
|
static String |
SP_DICOM_CLASS
Search parameter constant for dicom-class
|
static String |
SP_MODALITY
Search parameter constant for modality
|
static String |
SP_ORDER
Search parameter constant for order
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_SERIES
Search parameter constant for series
|
static String |
SP_STARTED
Search parameter constant for started
|
static String |
SP_STUDY
Search parameter constant for study
|
static String |
SP_UID
Search parameter constant for uid
|
static DateClientParam |
STARTED
Fluent Client search parameter constant for started
|
static UriClientParam |
STUDY
Fluent Client search parameter constant for study
|
static UriClientParam |
UID
Fluent Client search parameter constant for uid
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
ImagingStudy() |
| Modifier and Type | Method and 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 IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
String |
getAvailability()
Gets the value(s) for availability (status).
|
BoundCodeDt<InstanceAvailabilityEnum> |
getAvailabilityElement()
Gets the value(s) for availability (status).
|
String |
getDescription()
Gets the value(s) for description ().
|
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 ().
|
UnsignedIntDt |
getNumberOfInstancesElement()
Gets the value(s) for numberOfInstances ().
|
Integer |
getNumberOfSeries()
Gets the value(s) for numberOfSeries ().
|
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).
|
DateTimeDt |
getStartedElement()
Gets the value(s) for started (when.init).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
String |
getUid()
Gets the value(s) for uid (id).
|
OidDt |
getUidElement()
Gets the value(s) for uid (id).
|
String |
getUrl()
Gets the value(s) for url ().
|
UriDt |
getUrlElement()
Gets the value(s) for url ().
|
boolean |
isEmpty() |
ImagingStudy |
setAccession(IdentifierDt theValue)
Sets the value(s) for accession (id)
|
ImagingStudy |
setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)
Sets the value(s) for availability (status)
|
ImagingStudy |
setAvailability(InstanceAvailabilityEnum theValue)
Sets the value(s) for availability (status)
|
ImagingStudy |
setDescription(String theString)
Sets the value for description ()
|
ImagingStudy |
setDescription(StringDt theValue)
Sets the value(s) 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(UnsignedIntDt theValue)
Sets the value(s) for numberOfInstances ()
|
ImagingStudy |
setNumberOfSeries(int theInteger)
Sets the value for numberOfSeries ()
|
ImagingStudy |
setNumberOfSeries(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(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for started (when.init)
|
ImagingStudy |
setStarted(DateTimeDt theValue)
Sets the value(s) for started (when.init)
|
ImagingStudy |
setStartedWithSecondsPrecision(Date theDate)
Sets the value for started (when.init)
|
ImagingStudy |
setUid(OidDt theValue)
Sets the value(s) for uid (id)
|
ImagingStudy |
setUrl(String theUri)
Sets the value for url ()
|
ImagingStudy |
setUrl(UriDt theValue)
Sets the value(s) for url ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_PATIENT
Description: Who the study is about
Type: reference
Path: ImagingStudy.patient
public static final ReferenceClientParam PATIENT
Description: Who the study is about
Type: reference
Path: ImagingStudy.patient
public static final String SP_STARTED
Description: When the study was started
Type: date
Path: ImagingStudy.started
public static final DateClientParam STARTED
Description: When the study was started
Type: date
Path: ImagingStudy.started
public static final String SP_ACCESSION
Description: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
public static final TokenClientParam ACCESSION
Description: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
public static final String SP_STUDY
Description: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
public static final UriClientParam STUDY
Description: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
public static final String SP_SERIES
Description: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
public static final UriClientParam SERIES
Description: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
public static final String SP_MODALITY
Description: The modality of the series
Type: token
Path: ImagingStudy.series.modality
public static final TokenClientParam MODALITY
Description: The modality of the series
Type: token
Path: ImagingStudy.series.modality
public static final String SP_BODYSITE
Description: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
public static final TokenClientParam BODYSITE
Description: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
public static final String SP_UID
Description: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
public static final UriClientParam UID
Description: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
public static final String SP_DICOM_CLASS
Description: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
public static final UriClientParam DICOM_CLASS
Description: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
public static final String SP_ORDER
Description: The order for the image
Type: reference
Path: ImagingStudy.order
public static final ReferenceClientParam ORDER
Description: The order for the image
Type: reference
Path: ImagingStudy.order
public static final Include INCLUDE_ORDER
public static final Include INCLUDE_PATIENT
public ImagingStudy()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic DateTimeDt getStartedElement()
null.
Definition: Date and Time the study started
public Date getStarted()
null.
Definition: Date and Time the study started
public ImagingStudy setStarted(DateTimeDt theValue)
Definition: Date and Time the study started
public ImagingStudy setStarted(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: Date and Time the study started
public ImagingStudy setStartedWithSecondsPrecision(Date theDate)
Definition: Date and Time the study started
public ResourceReferenceDt getPatient()
null.
Definition: The patient imaged in the study.
public ImagingStudy setPatient(ResourceReferenceDt theValue)
Definition: The patient imaged in the study.
public OidDt getUidElement()
null.
Definition: Formal identifier for the study
public String getUid()
null.
Definition: Formal identifier for the study
public ImagingStudy setUid(OidDt theValue)
Definition: Formal identifier for the study
public IdentifierDt getAccession()
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)
public ImagingStudy setAccession(IdentifierDt theValue)
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)
public List<IdentifierDt> getIdentifier()
null.
Definition: Other identifiers for the study
public ImagingStudy setIdentifier(List<IdentifierDt> theValue)
Definition: Other identifiers for the study
public IdentifierDt addIdentifier()
Definition: Other identifiers for the study
public ImagingStudy addIdentifier(IdentifierDt theValue)
Definition: Other identifiers for the study
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: Other identifiers for the study
public List<ResourceReferenceDt> getOrder()
null.
Definition: A list of the diagnostic orders that resulted in this imaging study being performed
public ImagingStudy setOrder(List<ResourceReferenceDt> theValue)
Definition: A list of the diagnostic orders that resulted in this imaging study being performed
public ResourceReferenceDt addOrder()
Definition: A list of the diagnostic orders that resulted in this imaging study being performed
public List<CodingDt> getModalityList()
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)
public ImagingStudy setModalityList(List<CodingDt> theValue)
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)
public CodingDt addModalityList()
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)
public ImagingStudy addModalityList(CodingDt theValue)
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)
theValue - The modalityList to add (must not be null)public CodingDt getModalityListFirstRep()
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)
public ResourceReferenceDt getReferrer()
null.
Definition: The requesting/referring physician
public ImagingStudy setReferrer(ResourceReferenceDt theValue)
Definition: The requesting/referring physician
public BoundCodeDt<InstanceAvailabilityEnum> getAvailabilityElement()
null.
Definition: Availability of study (online, offline or nearline)
public String getAvailability()
null.
Definition: Availability of study (online, offline or nearline)
public ImagingStudy setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)
Definition: Availability of study (online, offline or nearline)
public ImagingStudy setAvailability(InstanceAvailabilityEnum theValue)
Definition: Availability of study (online, offline or nearline)
public UriDt getUrlElement()
null.
Definition: WADO-RS resource where Study is available.
public String getUrl()
null.
Definition: WADO-RS resource where Study is available.
public ImagingStudy setUrl(UriDt theValue)
Definition: WADO-RS resource where Study is available.
public ImagingStudy setUrl(String theUri)
Definition: WADO-RS resource where Study is available.
public UnsignedIntDt getNumberOfSeriesElement()
null.
Definition: Number of Series in Study
public Integer getNumberOfSeries()
null.
Definition: Number of Series in Study
public ImagingStudy setNumberOfSeries(UnsignedIntDt theValue)
Definition: Number of Series in Study
public ImagingStudy setNumberOfSeries(int theInteger)
Definition: Number of Series in Study
public UnsignedIntDt getNumberOfInstancesElement()
null.
Definition: Number of SOP Instances in Study
public Integer getNumberOfInstances()
null.
Definition: Number of SOP Instances in Study
public ImagingStudy setNumberOfInstances(UnsignedIntDt theValue)
Definition: Number of SOP Instances in Study
public ImagingStudy setNumberOfInstances(int theInteger)
Definition: Number of SOP Instances in Study
public List<ResourceReferenceDt> getProcedure()
null.
Definition: Type of procedure performed
public ImagingStudy setProcedure(List<ResourceReferenceDt> theValue)
Definition: Type of procedure performed
public ResourceReferenceDt addProcedure()
Definition: Type of procedure performed
public ResourceReferenceDt getInterpreter()
null.
Definition: Who read the study and interpreted the images or other content
public ImagingStudy setInterpreter(ResourceReferenceDt theValue)
Definition: Who read the study and interpreted the images or other content
public StringDt getDescriptionElement()
null.
Definition: Institution-generated description or classification of the Study performed
public String getDescription()
null.
Definition: Institution-generated description or classification of the Study performed
public ImagingStudy setDescription(StringDt theValue)
Definition: Institution-generated description or classification of the Study performed
public ImagingStudy setDescription(String theString)
Definition: Institution-generated description or classification of the Study performed
public List<ImagingStudy.Series> getSeries()
null.
Definition: Each study has one or more series of images or other content
public ImagingStudy setSeries(List<ImagingStudy.Series> theValue)
Definition: Each study has one or more series of images or other content
public ImagingStudy.Series addSeries()
Definition: Each study has one or more series of images or other content
public ImagingStudy addSeries(ImagingStudy.Series theValue)
Definition: Each study has one or more series of images or other content
theValue - The series to add (must not be null)public ImagingStudy.Series getSeriesFirstRep()
Definition: Each study has one or more series of images or other content
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.