ImagingStudy.Series (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.ImagingStudy.Series

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

ImagingStudy
```
public static class ImagingStudy.Series
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: ImagingStudy.series ()
Definition: Each study has one or more series of images or other content

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Series()

Constructors
Constructor and Description
`Series()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImagingStudy.SeriesInstance`	`addInstance()` Adds and returns a new value for instance ()
`ImagingStudy.Series`	`addInstance(ImagingStudy.SeriesInstance theValue)` Adds a given new value for instance ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getAvailability()` Gets the value(s) for availability ().
`BoundCodeDt<InstanceAvailabilityEnum>`	`getAvailabilityElement()` Gets the value(s) for availability ().
`CodingDt`	`getBodySite()` Gets the value(s) for bodySite ().
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`List<ImagingStudy.SeriesInstance>`	`getInstance()` Gets the value(s) for instance ().
`ImagingStudy.SeriesInstance`	`getInstanceFirstRep()` Gets the first repetition for instance (), creating it if it does not already exist.
`CodingDt`	`getLaterality()` Gets the value(s) for laterality ().
`CodingDt`	`getModality()` Gets the value(s) for modality ().
`Integer`	`getNumber()` Gets the value(s) for number ().
`UnsignedIntDt`	`getNumberElement()` Gets the value(s) for number ().
`Integer`	`getNumberOfInstances()` Gets the value(s) for numberOfInstances ().
`UnsignedIntDt`	`getNumberOfInstancesElement()` Gets the value(s) for numberOfInstances ().
`Date`	`getStarted()` Gets the value(s) for started ().
`DateTimeDt`	`getStartedElement()` Gets the value(s) for started ().
`String`	`getUid()` Gets the value(s) for uid ().
`OidDt`	`getUidElement()` Gets the value(s) for uid ().
`String`	`getUrl()` Gets the value(s) for url ().
`UriDt`	`getUrlElement()` Gets the value(s) for url ().
`boolean`	`isEmpty()`
`ImagingStudy.Series`	`setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)` Sets the value(s) for availability ()
`ImagingStudy.Series`	`setAvailability(InstanceAvailabilityEnum theValue)` Sets the value(s) for availability ()
`ImagingStudy.Series`	`setBodySite(CodingDt theValue)` Sets the value(s) for bodySite ()
`ImagingStudy.Series`	`setDescription(String theString)` Sets the value for description ()
`ImagingStudy.Series`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`ImagingStudy.Series`	`setInstance(List<ImagingStudy.SeriesInstance> theValue)` Sets the value(s) for instance ()
`ImagingStudy.Series`	`setLaterality(CodingDt theValue)` Sets the value(s) for laterality ()
`ImagingStudy.Series`	`setModality(CodingDt theValue)` Sets the value(s) for modality ()
`ImagingStudy.Series`	`setNumber(int theInteger)` Sets the value for number ()
`ImagingStudy.Series`	`setNumber(UnsignedIntDt theValue)` Sets the value(s) for number ()
`ImagingStudy.Series`	`setNumberOfInstances(int theInteger)` Sets the value for numberOfInstances ()
`ImagingStudy.Series`	`setNumberOfInstances(UnsignedIntDt theValue)` Sets the value(s) for numberOfInstances ()
`ImagingStudy.Series`	`setStarted(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for started ()
`ImagingStudy.Series`	`setStarted(DateTimeDt theValue)` Sets the value(s) for started ()
`ImagingStudy.Series`	`setStartedWithSecondsPrecision(Date theDate)` Sets the value for started ()
`ImagingStudy.Series`	`setUid(OidDt theValue)` Sets the value(s) for uid ()
`ImagingStudy.Series`	`setUrl(String theUri)` Sets the value for url ()
`ImagingStudy.Series`	`setUrl(UriDt theValue)` Sets the value(s) for url ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - Series
```
public Series()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getNumberElement
```
public UnsignedIntDt getNumberElement()
```
    Gets the value(s) for number (). creating it if it does not exist. Will not return null.
    Definition: The Numeric identifier of this series in the study.
  - getNumber
```
public Integer getNumber()
```
    Gets the value(s) for number (). creating it if it does not exist. Will not return null.
    Definition: The Numeric identifier of this series in the study.
  - setNumber
```
public ImagingStudy.Series setNumber(UnsignedIntDt theValue)
```
    Sets the value(s) for number ()
    Definition: The Numeric identifier of this series in the study.
  - setNumber
```
public ImagingStudy.Series setNumber(int theInteger)
```
    Sets the value for number ()
    Definition: The Numeric identifier of this series in the study.
  - getModality
```
public CodingDt getModality()
```
    Gets the value(s) for modality (). creating it if it does not exist. Will not return null.
    Definition: The modality of this series sequence
  - setModality
```
public ImagingStudy.Series setModality(CodingDt theValue)
```
    Sets the value(s) for modality ()
    Definition: The modality of this series sequence
  - getUidElement
```
public OidDt getUidElement()
```
    Gets the value(s) for uid (). creating it if it does not exist. Will not return null.
    Definition: Formal identifier for this series
  - getUid
```
public String getUid()
```
    Gets the value(s) for uid (). creating it if it does not exist. Will not return null.
    Definition: Formal identifier for this series
  - setUid
```
public ImagingStudy.Series setUid(OidDt theValue)
```
    Sets the value(s) for uid ()
    Definition: Formal identifier for this series
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A description of the series
  - getDescription
```
public String getDescription()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A description of the series
  - setDescription
```
public ImagingStudy.Series setDescription(StringDt theValue)
```
    Sets the value(s) for description ()
    Definition: A description of the series
  - setDescription
```
public ImagingStudy.Series setDescription(String theString)
```
    Sets the value for description ()
    Definition: A description of the series
  - getNumberOfInstancesElement
```
public 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 Series.
  - getNumberOfInstances
```
public Integer getNumberOfInstances()
```
    Gets the value(s) for numberOfInstances (). creating it if it does not exist. Will not return null.
    Definition: Number of SOP Instances in Series.
  - setNumberOfInstances
```
public ImagingStudy.Series setNumberOfInstances(UnsignedIntDt theValue)
```
    Sets the value(s) for numberOfInstances ()
    Definition: Number of SOP Instances in Series.
  - setNumberOfInstances
```
public ImagingStudy.Series setNumberOfInstances(int theInteger)
```
    Sets the value for numberOfInstances ()
    Definition: Number of SOP Instances in Series.
  - getAvailabilityElement
```
public BoundCodeDt<InstanceAvailabilityEnum> getAvailabilityElement()
```
    Gets the value(s) for availability (). creating it if it does not exist. Will not return null.
    Definition: Availability of series (online, offline or nearline)
  - getAvailability
```
public String getAvailability()
```
    Gets the value(s) for availability (). creating it if it does not exist. Will not return null.
    Definition: Availability of series (online, offline or nearline)
  - setAvailability
```
public ImagingStudy.Series setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)
```
    Sets the value(s) for availability ()
    Definition: Availability of series (online, offline or nearline)
  - setAvailability
```
public ImagingStudy.Series setAvailability(InstanceAvailabilityEnum theValue)
```
    Sets the value(s) for availability ()
    Definition: Availability of series (online, offline or nearline)
  - getUrlElement
```
public UriDt getUrlElement()
```
    Gets the value(s) for url (). creating it if it does not exist. Will not return null.
    Definition: URI/URL specifying the location of the referenced series using WADO-RS
  - getUrl
```
public String getUrl()
```
    Gets the value(s) for url (). creating it if it does not exist. Will not return null.
    Definition: URI/URL specifying the location of the referenced series using WADO-RS
  - setUrl
```
public ImagingStudy.Series setUrl(UriDt theValue)
```
    Sets the value(s) for url ()
    Definition: URI/URL specifying the location of the referenced series using WADO-RS
  - setUrl
```
public ImagingStudy.Series setUrl(String theUri)
```
    Sets the value for url ()
    Definition: URI/URL specifying the location of the referenced series using WADO-RS
  - getBodySite
```
public CodingDt getBodySite()
```
    Gets the value(s) for bodySite (). creating it if it does not exist. Will not return null.
    Definition: Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT
  - setBodySite
```
public ImagingStudy.Series setBodySite(CodingDt theValue)
```
    Sets the value(s) for bodySite ()
    Definition: Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT
  - getLaterality
```
public CodingDt getLaterality()
```
    Gets the value(s) for laterality (). creating it if it does not exist. Will not return null.
    Definition: Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.
  - setLaterality
```
public ImagingStudy.Series setLaterality(CodingDt theValue)
```
    Sets the value(s) for laterality ()
    Definition: Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.
  - getStartedElement
```
public DateTimeDt getStartedElement()
```
    Gets the value(s) for started (). creating it if it does not exist. Will not return null.
    Definition: The date and time the series was started.
  - getStarted
```
public Date getStarted()
```
    Gets the value(s) for started (). creating it if it does not exist. Will not return null.
    Definition: The date and time the series was started.
  - setStarted
```
public ImagingStudy.Series setStarted(DateTimeDt theValue)
```
    Sets the value(s) for started ()
    Definition: The date and time the series was started.
  - setStarted
```
public ImagingStudy.Series setStarted(Date theDate,
                                      TemporalPrecisionEnum thePrecision)
```
    Sets the value for started ()
    Definition: The date and time the series was started.
  - setStartedWithSecondsPrecision
```
public ImagingStudy.Series setStartedWithSecondsPrecision(Date theDate)
```
    Sets the value for started ()
    Definition: The date and time the series was started.
  - getInstance
```
public List<ImagingStudy.SeriesInstance> getInstance()
```
    Gets the value(s) for instance (). creating it if it does not exist. Will not return null.
    Definition: A single SOP Instance within the series, e.g. an image, or presentation state.
  - setInstance
```
public ImagingStudy.Series setInstance(List<ImagingStudy.SeriesInstance> theValue)
```
    Sets the value(s) for instance ()
    Definition: A single SOP Instance within the series, e.g. an image, or presentation state.
  - addInstance
```
public ImagingStudy.SeriesInstance addInstance()
```
    Adds and returns a new value for instance ()
    Definition: A single SOP Instance within the series, e.g. an image, or presentation state.
  - addInstance
```
public ImagingStudy.Series addInstance(ImagingStudy.SeriesInstance theValue)
```
    Adds a given new value for instance ()
    Definition: A single SOP Instance within the series, e.g. an image, or presentation state.
    
    Parameters:
    
    theValue - The instance to add (must not be null)
  - getInstanceFirstRep
```
public ImagingStudy.SeriesInstance getInstanceFirstRep()
```
    Gets the first repetition for instance (), creating it if it does not already exist.
    Definition: A single SOP Instance within the series, e.g. an image, or presentation state.

Class ImagingStudy.Series

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

Series

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getNumberElement

getNumber

setNumber

setNumber

getModality

setModality

getUidElement

getUid

setUid

getDescriptionElement

getDescription

setDescription

setDescription

getNumberOfInstancesElement

getNumberOfInstances

setNumberOfInstances

setNumberOfInstances

getAvailabilityElement

getAvailability

setAvailability

setAvailability

getUrlElement

getUrl

setUrl

setUrl

getBodySite

setBodySite

getLaterality

setLaterality

getStartedElement

getStarted

setStarted

setStarted

setStartedWithSecondsPrecision

getInstance

setInstance

addInstance

addInstance

getInstanceFirstRep