ImagingStudy.ImagingStudySeriesComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.Element
  - - org.hl7.fhir.dstu2016may.model.BackboneElement
    - - org.hl7.fhir.dstu2016may.model.ImagingStudy.ImagingStudySeriesComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

ImagingStudy
```
public static class ImagingStudy.ImagingStudySeriesComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Enumeration<ImagingStudy.InstanceAvailability>`	`availability` Availability of series (online, offline or nearline).
`protected Coding`	`bodySite` Body part examined.
`protected StringType`	`description` A description of the series.
`protected List<ImagingStudy.ImagingStudySeriesInstanceComponent>`	`instance` A single SOP Instance within the series, e.g.
`protected Coding`	`laterality` Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.
`protected Coding`	`modality` The modality of this series sequence.
`protected UnsignedIntType`	`number` The Numeric identifier of this series in the study.
`protected UnsignedIntType`	`numberOfInstances` Number of SOP Instances in Series.
`protected DateTimeType`	`started` The date and time the series was started.
`protected OidType`	`uid` Formal identifier for this series.
`protected UriType`	`url` URI/URL specifying the location of the referenced series using WADO-RS.

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description
`ImagingStudySeriesComponent()` Constructor
`ImagingStudySeriesComponent(OidType uid, Coding modality, UnsignedIntType numberOfInstances)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ImagingStudy.ImagingStudySeriesInstanceComponent`	`addInstance()`
`ImagingStudy.ImagingStudySeriesComponent`	`addInstance(ImagingStudy.ImagingStudySeriesInstanceComponent t)`
`ImagingStudy.ImagingStudySeriesComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`ImagingStudy.InstanceAvailability`	`getAvailability()`
`Enumeration<ImagingStudy.InstanceAvailability>`	`getAvailabilityElement()`
`Coding`	`getBodySite()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<ImagingStudy.ImagingStudySeriesInstanceComponent>`	`getInstance()`
`Coding`	`getLaterality()`
`Coding`	`getModality()`
`int`	`getNumber()`
`UnsignedIntType`	`getNumberElement()`
`int`	`getNumberOfInstances()`
`UnsignedIntType`	`getNumberOfInstancesElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Date`	`getStarted()`
`DateTimeType`	`getStartedElement()`
`String`	`getUid()`
`OidType`	`getUidElement()`
`String`	`getUrl()`
`UriType`	`getUrlElement()`
`boolean`	`hasAvailability()`
`boolean`	`hasAvailabilityElement()`
`boolean`	`hasBodySite()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasInstance()`
`boolean`	`hasLaterality()`
`boolean`	`hasModality()`
`boolean`	`hasNumber()`
`boolean`	`hasNumberElement()`
`boolean`	`hasNumberOfInstances()`
`boolean`	`hasNumberOfInstancesElement()`
`boolean`	`hasStarted()`
`boolean`	`hasStartedElement()`
`boolean`	`hasUid()`
`boolean`	`hasUidElement()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`ImagingStudy.ImagingStudySeriesComponent`	`setAvailability(ImagingStudy.InstanceAvailability value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setBodySite(Coding value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setDescription(String value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setDescriptionElement(StringType value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setLaterality(Coding value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setModality(Coding value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setNumber(int value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setNumberElement(UnsignedIntType value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setNumberOfInstances(int value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setNumberOfInstancesElement(UnsignedIntType value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setStarted(Date value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setStartedElement(DateTimeType value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setUid(String value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setUidElement(OidType value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setUrl(String value)`
`ImagingStudy.ImagingStudySeriesComponent`	`setUrlElement(UriType value)`

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - uid
```
protected OidType uid
```
    Formal identifier for this series.
  - number
```
protected UnsignedIntType number
```
    The Numeric identifier of this series in the study.
  - modality
```
protected Coding modality
```
    The modality of this series sequence.
  - description
```
protected StringType description
```
    A description of the series.
  - numberOfInstances
```
protected UnsignedIntType numberOfInstances
```
    Number of SOP Instances in Series.
  - availability
```
protected Enumeration<ImagingStudy.InstanceAvailability> availability
```
    Availability of series (online, offline or nearline).
  - url
```
protected UriType url
```
    URI/URL specifying the location of the referenced series using WADO-RS.
  - bodySite
```
protected Coding bodySite
```
    Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.
  - laterality
```
protected Coding laterality
```
    Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.
  - started
```
protected DateTimeType started
```
    The date and time the series was started.
  - instance
```
protected List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance
```
    A single SOP Instance within the series, e.g. an image, or presentation state.
- Constructor Detail
  - ImagingStudySeriesComponent
```
public ImagingStudySeriesComponent()
```
    Constructor
  - ImagingStudySeriesComponent
```
public ImagingStudySeriesComponent(OidType uid,
                                   Coding modality,
                                   UnsignedIntType numberOfInstances)
```
    Constructor
- Method Detail
  - getUidElement
```
public OidType getUidElement()
```
    Returns:
    
    uid (Formal identifier for this series.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
  - hasUidElement
```
public boolean hasUidElement()
```
  - hasUid
```
public boolean hasUid()
```
  - setUidElement
```
public ImagingStudy.ImagingStudySeriesComponent setUidElement(OidType value)
```
    Parameters:
    
    value - uid (Formal identifier for this series.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
  - getUid
```
public String getUid()
```
    Returns:
    
    Formal identifier for this series.
  - setUid
```
public ImagingStudy.ImagingStudySeriesComponent setUid(String value)
```
    Parameters:
    
    value - Formal identifier for this series.
  - getNumberElement
```
public UnsignedIntType getNumberElement()
```
    Returns:
    
    number (The Numeric identifier of this series in the study.). This is the underlying object with id, value and extensions. The accessor "getNumber" gives direct access to the value
  - hasNumberElement
```
public boolean hasNumberElement()
```
  - hasNumber
```
public boolean hasNumber()
```
  - setNumberElement
```
public ImagingStudy.ImagingStudySeriesComponent setNumberElement(UnsignedIntType value)
```
    Parameters:
    
    value - number (The Numeric identifier of this series in the study.). This is the underlying object with id, value and extensions. The accessor "getNumber" gives direct access to the value
  - getNumber
```
public int getNumber()
```
    Returns:
    
    The Numeric identifier of this series in the study.
  - setNumber
```
public ImagingStudy.ImagingStudySeriesComponent setNumber(int value)
```
    Parameters:
    
    value - The Numeric identifier of this series in the study.
  - getModality
```
public Coding getModality()
```
    Returns:
    
    modality (The modality of this series sequence.)
  - hasModality
```
public boolean hasModality()
```
  - setModality
```
public ImagingStudy.ImagingStudySeriesComponent setModality(Coding value)
```
    Parameters:
    
    value - modality (The modality of this series sequence.)
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (A description of the series.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public ImagingStudy.ImagingStudySeriesComponent setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (A description of the series.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    A description of the series.
  - setDescription
```
public ImagingStudy.ImagingStudySeriesComponent setDescription(String value)
```
    Parameters:
    
    value - A description of the series.
  - getNumberOfInstancesElement
```
public UnsignedIntType getNumberOfInstancesElement()
```
    Returns:
    
    numberOfInstances (Number of SOP Instances in Series.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the value
  - hasNumberOfInstancesElement
```
public boolean hasNumberOfInstancesElement()
```
  - hasNumberOfInstances
```
public boolean hasNumberOfInstances()
```
  - setNumberOfInstancesElement
```
public ImagingStudy.ImagingStudySeriesComponent setNumberOfInstancesElement(UnsignedIntType value)
```
    Parameters:
    
    value - numberOfInstances (Number of SOP Instances in Series.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the value
  - getNumberOfInstances
```
public int getNumberOfInstances()
```
    Returns:
    
    Number of SOP Instances in Series.
  - setNumberOfInstances
```
public ImagingStudy.ImagingStudySeriesComponent setNumberOfInstances(int value)
```
    Parameters:
    
    value - Number of SOP Instances in Series.
  - getAvailabilityElement
```
public Enumeration<ImagingStudy.InstanceAvailability> getAvailabilityElement()
```
    Returns:
    
    availability (Availability of series (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
  - hasAvailabilityElement
```
public boolean hasAvailabilityElement()
```
  - hasAvailability
```
public boolean hasAvailability()
```
  - setAvailabilityElement
```
public ImagingStudy.ImagingStudySeriesComponent setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)
```
    Parameters:
    
    value - availability (Availability of series (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
  - getAvailability
```
public ImagingStudy.InstanceAvailability getAvailability()
```
    Returns:
    
    Availability of series (online, offline or nearline).
  - setAvailability
```
public ImagingStudy.ImagingStudySeriesComponent setAvailability(ImagingStudy.InstanceAvailability value)
```
    Parameters:
    
    value - Availability of series (online, offline or nearline).
  - getUrlElement
```
public UriType getUrlElement()
```
    Returns:
    
    url (URI/URL specifying the location of the referenced series using WADO-RS.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - hasUrlElement
```
public boolean hasUrlElement()
```
  - hasUrl
```
public boolean hasUrl()
```
  - setUrlElement
```
public ImagingStudy.ImagingStudySeriesComponent setUrlElement(UriType value)
```
    Parameters:
    
    value - url (URI/URL specifying the location of the referenced series using WADO-RS.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - getUrl
```
public String getUrl()
```
    Returns:
    
    URI/URL specifying the location of the referenced series using WADO-RS.
  - setUrl
```
public ImagingStudy.ImagingStudySeriesComponent setUrl(String value)
```
    Parameters:
    
    value - URI/URL specifying the location of the referenced series using WADO-RS.
  - getBodySite
```
public Coding getBodySite()
```
    Returns:
    
    bodySite (Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.)
  - hasBodySite
```
public boolean hasBodySite()
```
  - setBodySite
```
public ImagingStudy.ImagingStudySeriesComponent setBodySite(Coding value)
```
    Parameters:
    
    value - bodySite (Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.)
  - getLaterality
```
public Coding getLaterality()
```
    Returns:
    
    laterality (Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.)
  - hasLaterality
```
public boolean hasLaterality()
```
  - setLaterality
```
public ImagingStudy.ImagingStudySeriesComponent setLaterality(Coding value)
```
    Parameters:
    
    value - laterality (Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.)
  - getStartedElement
```
public DateTimeType getStartedElement()
```
    Returns:
    
    started (The date and time the series was started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the value
  - hasStartedElement
```
public boolean hasStartedElement()
```
  - hasStarted
```
public boolean hasStarted()
```
  - setStartedElement
```
public ImagingStudy.ImagingStudySeriesComponent setStartedElement(DateTimeType value)
```
    Parameters:
    
    value - started (The date and time the series was started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the value
  - getStarted
```
public Date getStarted()
```
    Returns:
    
    The date and time the series was started.
  - setStarted
```
public ImagingStudy.ImagingStudySeriesComponent setStarted(Date value)
```
    Parameters:
    
    value - The date and time the series was started.
  - getInstance
```
public List<ImagingStudy.ImagingStudySeriesInstanceComponent> getInstance()
```
    Returns:
    
    instance (A single SOP Instance within the series, e.g. an image, or presentation state.)
  - hasInstance
```
public boolean hasInstance()
```
  - addInstance
```
public ImagingStudy.ImagingStudySeriesInstanceComponent addInstance()
```
    Returns:
    
    instance (A single SOP Instance within the series, e.g. an image, or presentation state.)
  - addInstance
```
public ImagingStudy.ImagingStudySeriesComponent addInstance(ImagingStudy.ImagingStudySeriesInstanceComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public ImagingStudy.ImagingStudySeriesComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class ImagingStudy.ImagingStudySeriesComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

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

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

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

Field Detail

uid

number

modality

description

numberOfInstances

availability

url

bodySite

laterality

started

instance

Constructor Detail

ImagingStudySeriesComponent

ImagingStudySeriesComponent

Method Detail

getUidElement

hasUidElement

hasUid

setUidElement

getUid

setUid

getNumberElement

hasNumberElement

hasNumber

setNumberElement

getNumber

setNumber

getModality

hasModality

setModality

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getNumberOfInstancesElement

hasNumberOfInstancesElement

hasNumberOfInstances

setNumberOfInstancesElement

getNumberOfInstances

setNumberOfInstances

getAvailabilityElement

hasAvailabilityElement

hasAvailability

setAvailabilityElement

getAvailability

setAvailability

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getBodySite

hasBodySite

setBodySite

getLaterality

hasLaterality

setLaterality

getStartedElement

hasStartedElement

hasStarted

setStartedElement

getStarted

setStarted