ImagingStudy.Series (HAPI FHIR Structures - DSTU1 (FHIR v0.80) 2.5 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu.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 (Each study has one or more series of instances)
Definition: Each study has one or more series of image instances

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 (A single instance taken from a patient (image or other))
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`BoundCodeDt<InstanceAvailabilityEnum>`	`getAvailability()` Gets the value(s) for availability (ONLINE \| OFFLINE \| NEARLINE \| UNAVAILABLE (0008,0056)).
`BoundCodeDt<InstanceAvailabilityEnum>`	`getAvailabilityElement()` Gets the value(s) for availability (ONLINE \| OFFLINE \| NEARLINE \| UNAVAILABLE (0008,0056)).
`CodingDt`	`getBodySite()` Gets the value(s) for bodySite (Body part examined (Map from 0018,0015)).
`CodingDt`	`getBodySiteElement()` Gets the value(s) for bodySite (Body part examined (Map from 0018,0015)).
`DateTimeDt`	`getDateTime()` Gets the value(s) for dateTime (When the series started).
`DateTimeDt`	`getDateTimeElement()` Gets the value(s) for dateTime (When the series started).
`StringDt`	`getDescription()` Gets the value(s) for description (A description of the series (0008,103E)).
`StringDt`	`getDescriptionElement()` Gets the value(s) for description (A description of the series (0008,103E)).
`List<ImagingStudy.SeriesInstance>`	`getInstance()` Gets the value(s) for instance (A single instance taken from a patient (image or other)).
`List<ImagingStudy.SeriesInstance>`	`getInstanceElement()` Gets the value(s) for instance (A single instance taken from a patient (image or other)).
`ImagingStudy.SeriesInstance`	`getInstanceFirstRep()` Gets the first repetition for instance (A single instance taken from a patient (image or other)), creating it if it does not already exist.
`BoundCodeDt<ModalityEnum>`	`getModality()` Gets the value(s) for modality (The modality of the instances in the series (0008,0060)).
`BoundCodeDt<ModalityEnum>`	`getModalityElement()` Gets the value(s) for modality (The modality of the instances in the series (0008,0060)).
`IntegerDt`	`getNumber()` Gets the value(s) for number (Number of this series in overall sequence (0020,0011)).
`IntegerDt`	`getNumberElement()` Gets the value(s) for number (Number of this series in overall sequence (0020,0011)).
`IntegerDt`	`getNumberOfInstances()` Gets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209)).
`IntegerDt`	`getNumberOfInstancesElement()` Gets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209)).
`OidDt`	`getUid()` Gets the value(s) for uid (Formal identifier for this series (0020,000E)).
`OidDt`	`getUidElement()` Gets the value(s) for uid (Formal identifier for this series (0020,000E)).
`UriDt`	`getUrl()` Gets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190)).
`UriDt`	`getUrlElement()` Gets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190)).
`boolean`	`isEmpty()`
`ImagingStudy.Series`	`setAvailability(BoundCodeDt<InstanceAvailabilityEnum> theValue)` Sets the value(s) for availability (ONLINE \| OFFLINE \| NEARLINE \| UNAVAILABLE (0008,0056))
`ImagingStudy.Series`	`setAvailability(InstanceAvailabilityEnum theValue)` Sets the value(s) for availability (ONLINE \| OFFLINE \| NEARLINE \| UNAVAILABLE (0008,0056))
`ImagingStudy.Series`	`setBodySite(CodingDt theValue)` Sets the value(s) for bodySite (Body part examined (Map from 0018,0015))
`ImagingStudy.Series`	`setDateTime(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for dateTime (When the series started)
`ImagingStudy.Series`	`setDateTime(DateTimeDt theValue)` Sets the value(s) for dateTime (When the series started)
`ImagingStudy.Series`	`setDateTimeWithSecondsPrecision(Date theDate)` Sets the value for dateTime (When the series started)
`ImagingStudy.Series`	`setDescription(String theString)` Sets the value for description (A description of the series (0008,103E))
`ImagingStudy.Series`	`setDescription(StringDt theValue)` Sets the value(s) for description (A description of the series (0008,103E))
`ImagingStudy.Series`	`setInstance(List<ImagingStudy.SeriesInstance> theValue)` Sets the value(s) for instance (A single instance taken from a patient (image or other))
`ImagingStudy.Series`	`setModality(BoundCodeDt<ModalityEnum> theValue)` Sets the value(s) for modality (The modality of the instances in the series (0008,0060))
`ImagingStudy.Series`	`setModality(ModalityEnum theValue)` Sets the value(s) for modality (The modality of the instances in the series (0008,0060))
`ImagingStudy.Series`	`setNumber(int theInteger)` Sets the value for number (Number of this series in overall sequence (0020,0011))
`ImagingStudy.Series`	`setNumber(IntegerDt theValue)` Sets the value(s) for number (Number of this series in overall sequence (0020,0011))
`ImagingStudy.Series`	`setNumberOfInstances(int theInteger)` Sets the value for numberOfInstances (Number of Series Related Instances (0020,1209))
`ImagingStudy.Series`	`setNumberOfInstances(IntegerDt theValue)` Sets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209))
`ImagingStudy.Series`	`setUid(OidDt theValue)` Sets the value(s) for uid (Formal identifier for this series (0020,000E))
`ImagingStudy.Series`	`setUrl(String theUri)` Sets the value for url (Retrieve URI (0008,1115 > 0008,1190))
`ImagingStudy.Series`	`setUrl(UriDt theValue)` Sets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190))

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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- 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
  - getNumber
```
public IntegerDt getNumber()
```
    Gets the value(s) for number (Number of this series in overall sequence (0020,0011)). creating it if it does not exist. Will not return null.
    Definition: The number of this series in the overall sequence
  - getNumberElement
```
public IntegerDt getNumberElement()
```
    Gets the value(s) for number (Number of this series in overall sequence (0020,0011)). creating it if it does not exist. Will not return null.
    Definition: The number of this series in the overall sequence
  - setNumber
```
public ImagingStudy.Series setNumber(IntegerDt theValue)
```
    Sets the value(s) for number (Number of this series in overall sequence (0020,0011))
    Definition: The number of this series in the overall sequence
  - setNumber
```
public ImagingStudy.Series setNumber(int theInteger)
```
    Sets the value for number (Number of this series in overall sequence (0020,0011))
    Definition: The number of this series in the overall sequence
  - getModality
```
public BoundCodeDt<ModalityEnum> getModality()
```
    Gets the value(s) for modality (The modality of the instances in the series (0008,0060)). creating it if it does not exist. Will not return null.
    Definition: The modality of this series sequence
  - getModalityElement
```
public BoundCodeDt<ModalityEnum> getModalityElement()
```
    Gets the value(s) for modality (The modality of the instances in the series (0008,0060)). creating it if it does not exist. Will not return null.
    Definition: The modality of this series sequence
  - setModality
```
public ImagingStudy.Series setModality(BoundCodeDt<ModalityEnum> theValue)
```
    Sets the value(s) for modality (The modality of the instances in the series (0008,0060))
    Definition: The modality of this series sequence
  - setModality
```
public ImagingStudy.Series setModality(ModalityEnum theValue)
```
    Sets the value(s) for modality (The modality of the instances in the series (0008,0060))
    Definition: The modality of this series sequence
  - getUid
```
public OidDt getUid()
```
    Gets the value(s) for uid (Formal identifier for this series (0020,000E)). creating it if it does not exist. Will not return null.
    Definition: Formal identifier for this series
  - getUidElement
```
public OidDt getUidElement()
```
    Gets the value(s) for uid (Formal identifier for this series (0020,000E)). 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 (Formal identifier for this series (0020,000E))
    Definition: Formal identifier for this series
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for description (A description of the series (0008,103E)). creating it if it does not exist. Will not return null.
    Definition: A description of the series
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (A description of the series (0008,103E)). 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 (A description of the series (0008,103E))
    Definition: A description of the series
  - setDescription
```
public ImagingStudy.Series setDescription(String theString)
```
    Sets the value for description (A description of the series (0008,103E))
    Definition: A description of the series
  - getNumberOfInstances
```
public IntegerDt getNumberOfInstances()
```
    Gets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209)). creating it if it does not exist. Will not return null.
    Definition: Sequence that contains attributes from the
  - getNumberOfInstancesElement
```
public IntegerDt getNumberOfInstancesElement()
```
    Gets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209)). creating it if it does not exist. Will not return null.
    Definition: Sequence that contains attributes from the
  - setNumberOfInstances
```
public ImagingStudy.Series setNumberOfInstances(IntegerDt theValue)
```
    Sets the value(s) for numberOfInstances (Number of Series Related Instances (0020,1209))
    Definition: Sequence that contains attributes from the
  - setNumberOfInstances
```
public ImagingStudy.Series setNumberOfInstances(int theInteger)
```
    Sets the value for numberOfInstances (Number of Series Related Instances (0020,1209))
    Definition: Sequence that contains attributes from the
  - getAvailability
```
public BoundCodeDt<InstanceAvailabilityEnum> getAvailability()
```
    Gets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)). creating it if it does not exist. Will not return null.
    Definition: Availability of series (online, offline or nearline)
  - getAvailabilityElement
```
public BoundCodeDt<InstanceAvailabilityEnum> getAvailabilityElement()
```
    Gets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)). 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 (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056))
    Definition: Availability of series (online, offline or nearline)
  - setAvailability
```
public ImagingStudy.Series setAvailability(InstanceAvailabilityEnum theValue)
```
    Sets the value(s) for availability (ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056))
    Definition: Availability of series (online, offline or nearline)
  - getUrl
```
public UriDt getUrl()
```
    Gets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190)). creating it if it does not exist. Will not return null.
    Definition: WADO-RS URI where Series is available
  - getUrlElement
```
public UriDt getUrlElement()
```
    Gets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190)). creating it if it does not exist. Will not return null.
    Definition: WADO-RS URI where Series is available
  - setUrl
```
public ImagingStudy.Series setUrl(UriDt theValue)
```
    Sets the value(s) for url (Retrieve URI (0008,1115 > 0008,1190))
    Definition: WADO-RS URI where Series is available
  - setUrl
```
public ImagingStudy.Series setUrl(String theUri)
```
    Sets the value for url (Retrieve URI (0008,1115 > 0008,1190))
    Definition: WADO-RS URI where Series is available
  - getBodySite
```
public CodingDt getBodySite()
```
    Gets the value(s) for bodySite (Body part examined (Map from 0018,0015)). 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
  - getBodySiteElement
```
public CodingDt getBodySiteElement()
```
    Gets the value(s) for bodySite (Body part examined (Map from 0018,0015)). 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
  - setBodySite
```
public ImagingStudy.Series setBodySite(CodingDt theValue)
```
    Sets the value(s) for bodySite (Body part examined (Map from 0018,0015))
    Definition: Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed
  - getDateTime
```
public DateTimeDt getDateTime()
```
    Gets the value(s) for dateTime (When the series started). creating it if it does not exist. Will not return null.
    Definition:
  - getDateTimeElement
```
public DateTimeDt getDateTimeElement()
```
    Gets the value(s) for dateTime (When the series started). creating it if it does not exist. Will not return null.
    Definition:
  - setDateTime
```
public ImagingStudy.Series setDateTime(DateTimeDt theValue)
```
    Sets the value(s) for dateTime (When the series started)
    Definition:
  - setDateTimeWithSecondsPrecision
```
public ImagingStudy.Series setDateTimeWithSecondsPrecision(Date theDate)
```
    Sets the value for dateTime (When the series started)
    Definition:
  - setDateTime
```
public ImagingStudy.Series setDateTime(Date theDate,
                                       TemporalPrecisionEnum thePrecision)
```
    Sets the value for dateTime (When the series started)
    Definition:
  - getInstance
```
public List<ImagingStudy.SeriesInstance> getInstance()
```
    Gets the value(s) for instance (A single instance taken from a patient (image or other)). creating it if it does not exist. Will not return null.
    Definition: A single image taken from a patient
  - getInstanceElement
```
public List<ImagingStudy.SeriesInstance> getInstanceElement()
```
    Gets the value(s) for instance (A single instance taken from a patient (image or other)). creating it if it does not exist. Will not return null.
    Definition: A single image taken from a patient
  - setInstance
```
public ImagingStudy.Series setInstance(List<ImagingStudy.SeriesInstance> theValue)
```
    Sets the value(s) for instance (A single instance taken from a patient (image or other))
    Definition: A single image taken from a patient
  - addInstance
```
public ImagingStudy.SeriesInstance addInstance()
```
    Adds and returns a new value for instance (A single instance taken from a patient (image or other))
    Definition: A single image taken from a patient
  - getInstanceFirstRep
```
public ImagingStudy.SeriesInstance getInstanceFirstRep()
```
    Gets the first repetition for instance (A single instance taken from a patient (image or other)), creating it if it does not already exist.
    Definition: A single image taken from a patient

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Constructor Detail

Series

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getNumber

getNumberElement

setNumber

setNumber

getModality

getModalityElement

setModality

setModality

getUid

getUidElement

setUid

getDescription

getDescriptionElement

setDescription

setDescription

getNumberOfInstances

getNumberOfInstancesElement

setNumberOfInstances

setNumberOfInstances

getAvailability

getAvailabilityElement

setAvailability

setAvailability

getUrl

getUrlElement

setUrl

setUrl

getBodySite

getBodySiteElement

setBodySite

getDateTime

getDateTimeElement

setDateTime

setDateTimeWithSecondsPrecision

setDateTime

getInstance

getInstanceElement

setInstance

addInstance

getInstanceFirstRep