Package com.ibm.fhir.model.resource
Class ImagingStudy.Series
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.ImagingStudy.Series
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- ImagingStudy
public static class ImagingStudy.Series extends BackboneElement
Each study has one or more series of images or other content.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImagingStudy.Series.Builderstatic classImagingStudy.Series.InstanceA single SOP instance within the series, e.g.static classImagingStudy.Series.PerformerIndicates who or what performed the series and how they were involved.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static ImagingStudy.Series.Builderbuilder()booleanequals(Object obj)CodinggetBodySite()The anatomic structures examined.StringgetDescription()A description of the series.List<Reference>getEndpoint()The network service providing access (e.g., query, view, or retrieval) for this series.List<ImagingStudy.Series.Instance>getInstance()A single SOP instance within the series, e.g.CodinggetLaterality()The laterality of the (possibly paired) anatomic structures examined.CodinggetModality()The modality of this series sequence.UnsignedIntgetNumber()The numeric identifier of this series in the study.UnsignedIntgetNumberOfInstances()Number of SOP Instances in the Study.List<ImagingStudy.Series.Performer>getPerformer()Indicates who or what performed the series and how they were involved.List<Reference>getSpecimen()The specimen imaged, e.g., for whole slide imaging of a biopsy.DateTimegetStarted()The date and time the series was started.IdgetUid()The DICOM Series Instance UID for the series.booleanhasChildren()inthashCode()ImagingStudy.Series.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getUid
public Id getUid()
The DICOM Series Instance UID for the series.- Returns:
- An immutable object of type
Idthat is non-null.
-
getNumber
public UnsignedInt getNumber()
The numeric identifier of this series in the study.- Returns:
- An immutable object of type
UnsignedIntthat may be null.
-
getModality
public Coding getModality()
The modality of this series sequence.- Returns:
- An immutable object of type
Codingthat is non-null.
-
getDescription
public String getDescription()
A description of the series.- Returns:
- An immutable object of type
Stringthat may be null.
-
getNumberOfInstances
public UnsignedInt getNumberOfInstances()
Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.- Returns:
- An immutable object of type
UnsignedIntthat may be null.
-
getEndpoint
public List<Reference> getEndpoint()
The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getBodySite
public Coding getBodySite()
The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema. org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series. laterality.- Returns:
- An immutable object of type
Codingthat may be null.
-
getLaterality
public Coding getLaterality()
The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.- Returns:
- An immutable object of type
Codingthat may be null.
-
getSpecimen
public List<Reference> getSpecimen()
The specimen imaged, e.g., for whole slide imaging of a biopsy.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getStarted
public DateTime getStarted()
The date and time the series was started.- Returns:
- An immutable object of type
DateTimethat may be null.
-
getPerformer
public List<ImagingStudy.Series.Performer> getPerformer()
Indicates who or what performed the series and how they were involved.- Returns:
- An unmodifiable list containing immutable objects of type
ImagingStudy.Series.Performerthat may be empty.
-
getInstance
public List<ImagingStudy.Series.Instance> getInstance()
A single SOP instance within the series, e.g. an image, or presentation state.- Returns:
- An unmodifiable list containing immutable objects of type
ImagingStudy.Series.Instancethat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public ImagingStudy.Series.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static ImagingStudy.Series.Builder builder()
-
-