public class ImagingStudy extends BaseResource implements IResource
Definition: Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images
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 (Each study has one or more series of instances)
|
static class |
ImagingStudy.SeriesInstance
Block class for child element: ImagingStudy.series.instance (A single instance taken from a patient (image or other))
|
| 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 DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static TokenClientParam |
DICOM_CLASS
Fluent Client search parameter constant for dicom-class
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
MODALITY
Fluent Client search parameter constant for modality
|
static TokenClientParam |
SERIES
Fluent Client search parameter constant for series
|
static NumberClientParam |
SIZE
Fluent Client search parameter constant for size
|
static String |
SP_ACCESSION
Search parameter constant for accession
|
static String |
SP_BODYSITE
Search parameter constant for bodysite
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_DICOM_CLASS
Search parameter constant for dicom-class
|
static String |
SP_MODALITY
Search parameter constant for modality
|
static String |
SP_SERIES
Search parameter constant for series
|
static String |
SP_SIZE
Search parameter constant for size
|
static String |
SP_STUDY
Search parameter constant for study
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_UID
Search parameter constant for uid
|
static TokenClientParam |
STUDY
Fluent Client search parameter constant for study
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static TokenClientParam |
UID
Fluent Client search parameter constant for uid
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
ImagingStudy() |
| Modifier and Type | Method and Description |
|---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (Other identifiers for the study (0020,0010))
|
ImagingStudy |
addIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Adds a new value for identifier (Other identifiers for the study (0020,0010))
|
ImagingStudy |
addIdentifier(String theSystem,
String theValue)
Adds a new value for identifier (Other identifiers for the study (0020,0010))
|
BoundCodeDt<ImagingModalityEnum> |
addModality()
Add a value for modality (All series.modality if actual acquisition modalities)
|
BoundCodeDt<ImagingModalityEnum> |
addModality(ImagingModalityEnum theValue)
Add a value for modality (All series.modality if actual acquisition modalities) using an enumerated type.
|
ResourceReferenceDt |
addOrder()
Adds and returns a new value for order (Order(s) that caused this study to be performed)
|
CodingDt |
addProcedure()
Adds and returns a new value for procedure (Type of procedure performed (0008,1032))
|
ImagingStudy.Series |
addSeries()
Adds and returns a new value for series (Each study has one or more series of instances)
|
IdentifierDt |
getAccessionNo()
Gets the value(s) for accessionNo (Accession Number (0008,0050)).
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
BoundCodeDt<InstanceAvailabilityEnum> |
getAvailability()
Gets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)).
|
StringDt |
getClinicalInformation()
Gets the value(s) for clinicalInformation (Diagnoses etc with request (0040,1002)).
|
DateTimeDt |
getDateTime()
Gets the value(s) for dateTime (When the study was performed).
|
StringDt |
getDescription()
Gets the value(s) for description (Institution-generated description (0008,1030)).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (Other identifiers for the study (0020,0010)).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (Other identifiers for the study (0020,0010)),
creating it if it does not already exist.
|
ResourceReferenceDt |
getInterpreter()
Gets the value(s) for interpreter (Who interpreted images (0008,1060)).
|
List<BoundCodeDt<ImagingModalityEnum>> |
getModality()
Gets the value(s) for modality (All series.modality if actual acquisition modalities).
|
BoundCodeDt<ImagingModalityEnum> |
getModalityFirstRep()
Gets the first repetition for modality (All series.modality if actual acquisition modalities),
creating it if it does not already exist.
|
IntegerDt |
getNumberOfInstances()
Gets the value(s) for numberOfInstances (Number of Study Related Instances (0020,1208)).
|
IntegerDt |
getNumberOfSeries()
Gets the value(s) for numberOfSeries (Number of Study Related Series (0020,1206)).
|
List<ResourceReferenceDt> |
getOrder()
Gets the value(s) for order (Order(s) that caused this study to be performed).
|
List<CodingDt> |
getProcedure()
Gets the value(s) for procedure (Type of procedure performed (0008,1032)).
|
CodingDt |
getProcedureFirstRep()
Gets the first repetition for procedure (Type of procedure performed (0008,1032)),
creating it if it does not already exist.
|
ResourceReferenceDt |
getReferrer()
Gets the value(s) for referrer (Referring physician (0008,0090)).
|
List<ImagingStudy.Series> |
getSeries()
Gets the value(s) for series (Each study has one or more series of instances).
|
ImagingStudy.Series |
getSeriesFirstRep()
Gets the first repetition for series (Each study has one or more series of instances),
creating it if it does not already exist.
|
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (Who the images are of).
|
OidDt |
getUid()
Gets the value(s) for uid (Formal identifier for the study (0020,000D)).
|
UriDt |
getUrl()
Gets the value(s) for url (Retrieve URI (0008,1190)).
|
boolean |
isEmpty() |
ImagingStudy |
setAccessionNo(IdentifierDt theValue)
Sets the value(s) for accessionNo (Accession Number (0008,0050))
|
ImagingStudy |
setAccessionNo(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Sets the value for accessionNo (Accession Number (0008,0050))
|
ImagingStudy |
setAccessionNo(String theSystem,
String theValue)
Sets the value for accessionNo (Accession Number (0008,0050))
|
ImagingStudy |
setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)
Sets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056))
|
ImagingStudy |
setAvailability(InstanceAvailabilityEnum theValue)
Sets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056))
|
ImagingStudy |
setClinicalInformation(String theString)
Sets the value for clinicalInformation (Diagnoses etc with request (0040,1002))
|
ImagingStudy |
setClinicalInformation(StringDt theValue)
Sets the value(s) for clinicalInformation (Diagnoses etc with request (0040,1002))
|
ImagingStudy |
setDateTime(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for dateTime (When the study was performed)
|
ImagingStudy |
setDateTime(DateTimeDt theValue)
Sets the value(s) for dateTime (When the study was performed)
|
ImagingStudy |
setDateTimeWithSecondsPrecision(Date theDate)
Sets the value for dateTime (When the study was performed)
|
ImagingStudy |
setDescription(String theString)
Sets the value for description (Institution-generated description (0008,1030))
|
ImagingStudy |
setDescription(StringDt theValue)
Sets the value(s) for description (Institution-generated description (0008,1030))
|
ImagingStudy |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (Other identifiers for the study (0020,0010))
|
ImagingStudy |
setInterpreter(ResourceReferenceDt theValue)
Sets the value(s) for interpreter (Who interpreted images (0008,1060))
|
ImagingStudy |
setModality(ImagingModalityEnum theValue)
Sets the value(s), and clears any existing value(s) for modality (All series.modality if actual acquisition modalities)
|
ImagingStudy |
setModality(List<BoundCodeDt<ImagingModalityEnum>> theValue)
Sets the value(s) for modality (All series.modality if actual acquisition modalities)
|
ImagingStudy |
setNumberOfInstances(int theInteger)
Sets the value for numberOfInstances (Number of Study Related Instances (0020,1208))
|
ImagingStudy |
setNumberOfInstances(IntegerDt theValue)
Sets the value(s) for numberOfInstances (Number of Study Related Instances (0020,1208))
|
ImagingStudy |
setNumberOfSeries(int theInteger)
Sets the value for numberOfSeries (Number of Study Related Series (0020,1206))
|
ImagingStudy |
setNumberOfSeries(IntegerDt theValue)
Sets the value(s) for numberOfSeries (Number of Study Related Series (0020,1206))
|
ImagingStudy |
setOrder(List<ResourceReferenceDt> theValue)
Sets the value(s) for order (Order(s) that caused this study to be performed)
|
ImagingStudy |
setProcedure(List<CodingDt> theValue)
Sets the value(s) for procedure (Type of procedure performed (0008,1032))
|
ImagingStudy |
setReferrer(ResourceReferenceDt theValue)
Sets the value(s) for referrer (Referring physician (0008,0090))
|
ImagingStudy |
setSeries(List<ImagingStudy.Series> theValue)
Sets the value(s) for series (Each study has one or more series of instances)
|
ImagingStudy |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (Who the images are of)
|
ImagingStudy |
setUid(OidDt theValue)
Sets the value(s) for uid (Formal identifier for the study (0020,000D))
|
ImagingStudy |
setUrl(String theUri)
Sets the value for url (Retrieve URI (0008,1190))
|
ImagingStudy |
setUrl(UriDt theValue)
Sets the value(s) for url (Retrieve URI (0008,1190))
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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, setResourceMetadatapublic static final String SP_SUBJECT
Description: Who the study is about
Type: reference
Path: ImagingStudy.subject
public static final ReferenceClientParam SUBJECT
Description: Who the study is about
Type: reference
Path: ImagingStudy.subject
public static final Include INCLUDE_SUBJECT
public static final String SP_DATE
Description: The date the study was done was taken
Type: date
Path: ImagingStudy.dateTime
public static final DateClientParam DATE
Description: The date the study was done was taken
Type: date
Path: ImagingStudy.dateTime
public static final String SP_ACCESSION
Description: The accession id for the image
Type: token
Path: ImagingStudy.accessionNo
public static final TokenClientParam ACCESSION
Description: The accession id for the image
Type: token
Path: ImagingStudy.accessionNo
public static final String SP_STUDY
Description: The study id for the image
Type: token
Path: ImagingStudy.uid
public static final TokenClientParam STUDY
Description: The study id for the image
Type: token
Path: ImagingStudy.uid
public static final String SP_SERIES
Description: The series id for the image
Type: token
Path: ImagingStudy.series.uid
public static final TokenClientParam SERIES
Description: The series id for the image
Type: token
Path: ImagingStudy.series.uid
public static final String SP_MODALITY
Description: The modality of the image
Type: token
Path: ImagingStudy.series.modality
public static final TokenClientParam MODALITY
Description: The modality of the image
Type: token
Path: ImagingStudy.series.modality
public static final String SP_SIZE
Description: The size of the image in MB - may include > or < in the value
Type: number
Path:
public static final NumberClientParam SIZE
Description: The size of the image in MB - may include > or < in the value
Type: number
Path:
public static final String SP_BODYSITE
Description:
Type: token
Path: ImagingStudy.series.bodySite
public static final TokenClientParam BODYSITE
Description:
Type: token
Path: ImagingStudy.series.bodySite
public static final String SP_UID
Description:
Type: token
Path: ImagingStudy.series.instance.uid
public static final TokenClientParam UID
Description:
Type: token
Path: ImagingStudy.series.instance.uid
public static final String SP_DICOM_CLASS
Description:
Type: token
Path: ImagingStudy.series.instance.sopclass
public static final TokenClientParam DICOM_CLASS
Description:
Type: token
Path: ImagingStudy.series.instance.sopclass
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic DateTimeDt getDateTime()
null.
Definition: Date and Time the study took place
public ImagingStudy setDateTime(DateTimeDt theValue)
Definition: Date and Time the study took place
public ImagingStudy setDateTimeWithSecondsPrecision(Date theDate)
Definition: Date and Time the study took place
public ImagingStudy setDateTime(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: Date and Time the study took place
public ResourceReferenceDt getSubject()
null.
Definition: Who the images are of
public ImagingStudy setSubject(ResourceReferenceDt theValue)
Definition: Who the images are of
public OidDt getUid()
null.
Definition: Formal identifier for the study
public ImagingStudy setUid(OidDt theValue)
Definition: Formal identifier for the study
public IdentifierDt getAccessionNo()
null.
Definition: Accession Number
public ImagingStudy setAccessionNo(IdentifierDt theValue)
Definition: Accession Number
public ImagingStudy setAccessionNo(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: Accession Number
public ImagingStudy setAccessionNo(String theSystem, String theValue)
Definition: Accession Number
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 IdentifierDt getIdentifierFirstRep()
Definition: Other identifiers for the study
public ImagingStudy addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: Other identifiers for the study
public ImagingStudy addIdentifier(String theSystem, String theValue)
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<BoundCodeDt<ImagingModalityEnum>> getModality()
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 setModality(List<BoundCodeDt<ImagingModalityEnum>> 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 BoundCodeDt<ImagingModalityEnum> addModality(ImagingModalityEnum theValue)
#addType() method.
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 BoundCodeDt<ImagingModalityEnum> getModalityFirstRep()
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 BoundCodeDt<ImagingModalityEnum> addModality()
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 setModality(ImagingModalityEnum 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 ResourceReferenceDt getReferrer()
null.
Definition: The requesting/referring physician
public ImagingStudy setReferrer(ResourceReferenceDt theValue)
Definition: The requesting/referring physician
public BoundCodeDt<InstanceAvailabilityEnum> 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 getUrl()
null.
Definition: WADO-RS URI where Study is available
public ImagingStudy setUrl(UriDt theValue)
Definition: WADO-RS URI where Study is available
public ImagingStudy setUrl(String theUri)
Definition: WADO-RS URI where Study is available
public IntegerDt getNumberOfSeries()
null.
Definition: Number of Series in Study
public ImagingStudy setNumberOfSeries(IntegerDt theValue)
Definition: Number of Series in Study
public ImagingStudy setNumberOfSeries(int theInteger)
Definition: Number of Series in Study
public IntegerDt getNumberOfInstances()
null.
Definition: Number of SOP Instances in Study
public ImagingStudy setNumberOfInstances(IntegerDt theValue)
Definition: Number of SOP Instances in Study
public ImagingStudy setNumberOfInstances(int theInteger)
Definition: Number of SOP Instances in Study
public StringDt getClinicalInformation()
null.
Definition: Diagnoses etc provided with request
public ImagingStudy setClinicalInformation(StringDt theValue)
Definition: Diagnoses etc provided with request
public ImagingStudy setClinicalInformation(String theString)
Definition: Diagnoses etc provided with request
public List<CodingDt> getProcedure()
null.
Definition: Type of procedure performed
public ImagingStudy setProcedure(List<CodingDt> theValue)
Definition: Type of procedure performed
public CodingDt addProcedure()
Definition: Type of procedure performed
public CodingDt getProcedureFirstRep()
Definition: Type of procedure performed
public ResourceReferenceDt getInterpreter()
null.
Definition: Who read study and interpreted the images
public ImagingStudy setInterpreter(ResourceReferenceDt theValue)
Definition: Who read study and interpreted the images
public StringDt getDescription()
null.
Definition: Institution-generated description or classification of the Study (component) performed
public ImagingStudy setDescription(StringDt theValue)
Definition: Institution-generated description or classification of the Study (component) performed
public ImagingStudy setDescription(String theString)
Definition: Institution-generated description or classification of the Study (component) performed
public List<ImagingStudy.Series> getSeries()
null.
Definition: Each study has one or more series of image instances
public ImagingStudy setSeries(List<ImagingStudy.Series> theValue)
Definition: Each study has one or more series of image instances
public ImagingStudy.Series addSeries()
Definition: Each study has one or more series of image instances
public ImagingStudy.Series getSeriesFirstRep()
Definition: Each study has one or more series of image instances
Copyright © 2014 University Health Network. All rights reserved.