Class ImagingStudy.Series.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.ImagingStudy.Series.Builder
-
- Enclosing class:
- ImagingStudy.Series
public static class ImagingStudy.Series.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImagingStudy.Series.Builder
bodySite(Coding bodySite)
The anatomic structures examined.ImagingStudy.Series
build()
Build theImagingStudy.Series
ImagingStudy.Series.Builder
description(java.lang.String description)
Convenience method for settingdescription
.ImagingStudy.Series.Builder
description(String description)
A description of the series.ImagingStudy.Series.Builder
endpoint(java.util.Collection<Reference> endpoint)
The network service providing access (e.g., query, view, or retrieval) for this series.ImagingStudy.Series.Builder
endpoint(Reference... endpoint)
The network service providing access (e.g., query, view, or retrieval) for this series.ImagingStudy.Series.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.ImagingStudy.Series.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ImagingStudy.Series.Builder
from(ImagingStudy.Series series)
ImagingStudy.Series.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ImagingStudy.Series.Builder
instance(java.util.Collection<ImagingStudy.Series.Instance> instance)
A single SOP instance within the series, e.g.ImagingStudy.Series.Builder
instance(ImagingStudy.Series.Instance... instance)
A single SOP instance within the series, e.g.ImagingStudy.Series.Builder
laterality(Coding laterality)
The laterality of the (possibly paired) anatomic structures examined.ImagingStudy.Series.Builder
modality(Coding modality)
The modality of this series sequence.ImagingStudy.Series.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.ImagingStudy.Series.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.ImagingStudy.Series.Builder
number(UnsignedInt number)
The numeric identifier of this series in the study.ImagingStudy.Series.Builder
numberOfInstances(UnsignedInt numberOfInstances)
Number of SOP Instances in the Study.ImagingStudy.Series.Builder
performer(java.util.Collection<ImagingStudy.Series.Performer> performer)
Indicates who or what performed the series and how they were involved.ImagingStudy.Series.Builder
performer(ImagingStudy.Series.Performer... performer)
Indicates who or what performed the series and how they were involved.ImagingStudy.Series.Builder
specimen(java.util.Collection<Reference> specimen)
The specimen imaged, e.g., for whole slide imaging of a biopsy.ImagingStudy.Series.Builder
specimen(Reference... specimen)
The specimen imaged, e.g., for whole slide imaging of a biopsy.ImagingStudy.Series.Builder
started(DateTime started)
The date and time the series was started.ImagingStudy.Series.Builder
uid(Id uid)
The DICOM Series Instance UID for the series.protected void
validate(ImagingStudy.Series series)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public ImagingStudy.Series.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public ImagingStudy.Series.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public ImagingStudy.Series.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public ImagingStudy.Series.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public ImagingStudy.Series.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
uid
public ImagingStudy.Series.Builder uid(Id uid)
The DICOM Series Instance UID for the series.This element is required.
- Parameters:
uid
- DICOM Series Instance UID for the series- Returns:
- A reference to this Builder instance
-
number
public ImagingStudy.Series.Builder number(UnsignedInt number)
The numeric identifier of this series in the study.- Parameters:
number
- Numeric identifier of this series- Returns:
- A reference to this Builder instance
-
modality
public ImagingStudy.Series.Builder modality(Coding modality)
The modality of this series sequence.This element is required.
- Parameters:
modality
- The modality of the instances in the series- Returns:
- A reference to this Builder instance
-
description
public ImagingStudy.Series.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- A short human readable summary of the series- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public ImagingStudy.Series.Builder description(String description)
A description of the series.- Parameters:
description
- A short human readable summary of the series- Returns:
- A reference to this Builder instance
-
numberOfInstances
public ImagingStudy.Series.Builder numberOfInstances(UnsignedInt numberOfInstances)
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.- Parameters:
numberOfInstances
- Number of Series Related Instances- Returns:
- A reference to this Builder instance
-
endpoint
public ImagingStudy.Series.Builder endpoint(Reference... endpoint)
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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
endpoint
- Series access endpoint- Returns:
- A reference to this Builder instance
-
endpoint
public ImagingStudy.Series.Builder endpoint(java.util.Collection<Reference> endpoint)
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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
endpoint
- Series access endpoint- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
bodySite
public ImagingStudy.Series.Builder bodySite(Coding bodySite)
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.- Parameters:
bodySite
- Body part examined- Returns:
- A reference to this Builder instance
-
laterality
public ImagingStudy.Series.Builder laterality(Coding laterality)
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.- Parameters:
laterality
- Body part laterality- Returns:
- A reference to this Builder instance
-
specimen
public ImagingStudy.Series.Builder specimen(Reference... specimen)
The specimen imaged, e.g., for whole slide imaging of a biopsy.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
specimen
- Specimen imaged- Returns:
- A reference to this Builder instance
-
specimen
public ImagingStudy.Series.Builder specimen(java.util.Collection<Reference> specimen)
The specimen imaged, e.g., for whole slide imaging of a biopsy.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
specimen
- Specimen imaged- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
started
public ImagingStudy.Series.Builder started(DateTime started)
The date and time the series was started.- Parameters:
started
- When the series started- Returns:
- A reference to this Builder instance
-
performer
public ImagingStudy.Series.Builder performer(ImagingStudy.Series.Performer... performer)
Indicates who or what performed the series and how they were involved.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
performer
- Who performed the series- Returns:
- A reference to this Builder instance
-
performer
public ImagingStudy.Series.Builder performer(java.util.Collection<ImagingStudy.Series.Performer> performer)
Indicates who or what performed the series and how they were involved.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
performer
- Who performed the series- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
instance
public ImagingStudy.Series.Builder instance(ImagingStudy.Series.Instance... instance)
A single SOP instance within the series, e.g. an image, or presentation state.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
instance
- A single SOP instance from the series- Returns:
- A reference to this Builder instance
-
instance
public ImagingStudy.Series.Builder instance(java.util.Collection<ImagingStudy.Series.Instance> instance)
A single SOP instance within the series, e.g. an image, or presentation state.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
instance
- A single SOP instance from the series- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ImagingStudy.Series build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ImagingStudy.Series
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Series per the base specification
-
validate
protected void validate(ImagingStudy.Series series)
-
from
protected ImagingStudy.Series.Builder from(ImagingStudy.Series series)
-
-