Class ImagingStudy.Series

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    ImagingStudy

    public static class ImagingStudy.Series
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.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 Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getNumberElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: The Numeric identifier of this series in the study.

      • setNumber

        public ImagingStudy.Series setNumber​(ca.uhn.fhir.model.primitive.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

      • getUidElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: Formal identifier for this series

      • setUid

        public ImagingStudy.Series setUid​(ca.uhn.fhir.model.primitive.OidDt theValue)
        Sets the value(s) for uid ()

        Definition: Formal identifier for this series

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: A description of the series

      • setDescription

        public ImagingStudy.Series setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A description of the series

      • getNumberOfInstancesElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: Number of SOP Instances in Series.

      • setNumberOfInstances

        public ImagingStudy.Series setNumberOfInstances​(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
        Sets the value(s) for numberOfInstances ()

        Definition: Number of SOP Instances in Series.

      • getAvailabilityElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<InstanceAvailabilityEnumgetAvailabilityElement()
        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. This method may return null.

        Definition: Availability of series (online, offline or nearline)

      • getUrlElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: URI/URL specifying the location of the referenced series using WADO-RS

      • setUrl

        public ImagingStudy.Series setUrl​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: The date and time the series was started.

      • setStarted

        public ImagingStudy.Series setStarted​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for started ()

        Definition: The date and time the series was started.

      • setStarted

        public ImagingStudy.Series setStarted​(Date theDate,
                                              ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for started ()

        Definition: The date and time the series was started.

      • getInstance

        public List<ImagingStudy.SeriesInstancegetInstance()
        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.

      • 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.