Package org.hl7.fhir.r5.model

Class ImagingSelection.ImagingSelectionInstanceComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.ImagingSelection.ImagingSelectionInstanceComponent

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:

ImagingSelection

public static class ImagingSelection.ImagingSelectionInstanceComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ImagingSelection.ImageRegion2DComponent>	imageRegion2D	Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.
protected List<ImagingSelection.ImageRegion3DComponent>	imageRegion3D	Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.
protected UnsignedIntType	number	The Instance Number for the selected DICOM instance.
protected Coding	sopClass	The SOP Class UID for the selected DICOM instance.
protected List<StringType>	subset	Selected subset of the SOP Instance.
protected IdType	uid	The SOP Instance UID for the selected DICOM instance.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ImagingSelectionInstanceComponent()	Constructor
ImagingSelectionInstanceComponent(String uid)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ImagingSelection.ImageRegion2DComponent	addImageRegion2D()
ImagingSelection.ImagingSelectionInstanceComponent	addImageRegion2D(ImagingSelection.ImageRegion2DComponent t)
ImagingSelection.ImageRegion3DComponent	addImageRegion3D()
ImagingSelection.ImagingSelectionInstanceComponent	addImageRegion3D(ImagingSelection.ImageRegion3DComponent t)
ImagingSelection.ImagingSelectionInstanceComponent	addSubset(String value)
StringType	addSubsetElement()
ImagingSelection.ImagingSelectionInstanceComponent	copy()
void	copyValues(ImagingSelection.ImagingSelectionInstanceComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ImagingSelection.ImageRegion2DComponent>	getImageRegion2D()
ImagingSelection.ImageRegion2DComponent	getImageRegion2DFirstRep()
List<ImagingSelection.ImageRegion3DComponent>	getImageRegion3D()
ImagingSelection.ImageRegion3DComponent	getImageRegion3DFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
int	getNumber()
UnsignedIntType	getNumberElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Coding	getSopClass()
List<StringType>	getSubset()
String[]	getTypesForProperty(int hash, String name)
String	getUid()
IdType	getUidElement()
boolean	hasImageRegion2D()
boolean	hasImageRegion3D()
boolean	hasNumber()
boolean	hasNumberElement()
boolean	hasSopClass()
boolean	hasSubset()
boolean	hasSubset(String value)
boolean	hasUid()
boolean	hasUidElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ImagingSelection.ImagingSelectionInstanceComponent	setImageRegion2D(List<ImagingSelection.ImageRegion2DComponent> theImageRegion2D)
ImagingSelection.ImagingSelectionInstanceComponent	setImageRegion3D(List<ImagingSelection.ImageRegion3DComponent> theImageRegion3D)
ImagingSelection.ImagingSelectionInstanceComponent	setNumber(int value)
ImagingSelection.ImagingSelectionInstanceComponent	setNumberElement(UnsignedIntType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ImagingSelection.ImagingSelectionInstanceComponent	setSopClass(Coding value)
ImagingSelection.ImagingSelectionInstanceComponent	setSubset(List<StringType> theSubset)
ImagingSelection.ImagingSelectionInstanceComponent	setUid(String value)
ImagingSelection.ImagingSelectionInstanceComponent	setUidElement(IdType value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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 Details

uid

protected IdType uid

The SOP Instance UID for the selected DICOM instance.

number

protected UnsignedIntType number

The Instance Number for the selected DICOM instance.

sopClass

protected Coding sopClass

The SOP Class UID for the selected DICOM instance.

subset

protected List<StringType> subset

Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.

imageRegion2D

protected List<ImagingSelection.ImageRegion2DComponent> imageRegion2D

Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.

imageRegion3D

protected List<ImagingSelection.ImageRegion3DComponent> imageRegion3D

Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.

Constructor Details

ImagingSelectionInstanceComponent

public ImagingSelectionInstanceComponent()

Constructor

ImagingSelectionInstanceComponent

public ImagingSelectionInstanceComponent(String uid)

Constructor

Method Details

getUidElement

public IdType getUidElement()

Returns:

uid (The SOP Instance UID for the selected DICOM instance.). 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 ImagingSelection.ImagingSelectionInstanceComponent setUidElement(IdType value)

Parameters:

value - uid (The SOP Instance UID for the selected DICOM instance.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value

getUid

public String getUid()

Returns:

The SOP Instance UID for the selected DICOM instance.

setUid

public ImagingSelection.ImagingSelectionInstanceComponent setUid(String value)

Parameters:

value - The SOP Instance UID for the selected DICOM instance.

getNumberElement

public UnsignedIntType getNumberElement()

Returns:

number (The Instance Number for the selected DICOM instance.). 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 ImagingSelection.ImagingSelectionInstanceComponent setNumberElement(UnsignedIntType value)

Parameters:

value - number (The Instance Number for the selected DICOM instance.). 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 Instance Number for the selected DICOM instance.

setNumber

public ImagingSelection.ImagingSelectionInstanceComponent setNumber(int value)

Parameters:

value - The Instance Number for the selected DICOM instance.

getSopClass

public Coding getSopClass()

Returns:

sopClass (The SOP Class UID for the selected DICOM instance.)

hasSopClass

public boolean hasSopClass()

setSopClass

public ImagingSelection.ImagingSelectionInstanceComponent setSopClass(Coding value)

Parameters:

value - sopClass (The SOP Class UID for the selected DICOM instance.)

getSubset

public List<StringType> getSubset()

Returns:

subset (Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.)

setSubset

public ImagingSelection.ImagingSelectionInstanceComponent setSubset(List<StringType> theSubset)

Returns:

Returns a reference to this for easy method chaining

hasSubset

public boolean hasSubset()

addSubsetElement

public StringType addSubsetElement()

Returns:

subset (Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.)

addSubset

public ImagingSelection.ImagingSelectionInstanceComponent addSubset(String value)

Parameters:

value - subset (Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.)

hasSubset

public boolean hasSubset(String value)

Parameters:

value - subset (Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.)

getImageRegion2D

public List<ImagingSelection.ImageRegion2DComponent> getImageRegion2D()

Returns:

imageRegion2D (Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.)

setImageRegion2D

public ImagingSelection.ImagingSelectionInstanceComponent setImageRegion2D(List<ImagingSelection.ImageRegion2DComponent> theImageRegion2D)

Returns:

Returns a reference to this for easy method chaining

hasImageRegion2D

public boolean hasImageRegion2D()

addImageRegion2D

public ImagingSelection.ImageRegion2DComponent addImageRegion2D()

addImageRegion2D

public ImagingSelection.ImagingSelectionInstanceComponent addImageRegion2D(ImagingSelection.ImageRegion2DComponent t)

getImageRegion2DFirstRep

public ImagingSelection.ImageRegion2DComponent getImageRegion2DFirstRep()

Returns:

The first repetition of repeating field imageRegion2D, creating it if it does not already exist {3}

getImageRegion3D

public List<ImagingSelection.ImageRegion3DComponent> getImageRegion3D()

Returns:

imageRegion3D (Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.)

setImageRegion3D

public ImagingSelection.ImagingSelectionInstanceComponent setImageRegion3D(List<ImagingSelection.ImageRegion3DComponent> theImageRegion3D)

Returns:

Returns a reference to this for easy method chaining

hasImageRegion3D

public boolean hasImageRegion3D()

addImageRegion3D

public ImagingSelection.ImageRegion3DComponent addImageRegion3D()

addImageRegion3D

public ImagingSelection.ImagingSelectionInstanceComponent addImageRegion3D(ImagingSelection.ImageRegion3DComponent t)

getImageRegion3DFirstRep

public ImagingSelection.ImageRegion3DComponent getImageRegion3DFirstRep()

Returns:

The first repetition of repeating field imageRegion3D, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

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 Base 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 Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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 ImagingSelection.ImagingSelectionInstanceComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ImagingSelection.ImagingSelectionInstanceComponent dst)

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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)