Package org.hl7.fhir.r5.model

Class ImagingStudy.ImagingStudySeriesComponent

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

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 CodeableReference	bodySite	The anatomic structures examined.
protected StringType	description	A description of the series.
protected List<Reference>	endpoint	The network service providing access (e.g., query, view, or retrieval) for this series.
protected List<ImagingStudy.ImagingStudySeriesInstanceComponent>	instance	A single SOP instance within the series, e.g.
protected CodeableConcept	laterality	The laterality of the (possibly paired) anatomic structures examined.
protected CodeableConcept	modality	The distinct modality for this series.
protected UnsignedIntType	number	The numeric identifier of this series in the study.
protected UnsignedIntType	numberOfInstances	Number of SOP Instances in the Study.
protected List<ImagingStudy.ImagingStudySeriesPerformerComponent>	performer	Indicates who or what performed the series and how they were involved.
protected List<Reference>	specimen	The specimen imaged, e.g., for whole slide imaging of a biopsy.
protected DateTimeType	started	The date and time the series was started.
protected IdType	uid	The DICOM Series Instance UID for the series.

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
ImagingStudySeriesComponent()	Constructor
ImagingStudySeriesComponent(String uid, CodeableConcept modality)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addEndpoint()
ImagingStudy.ImagingStudySeriesComponent	addEndpoint(Reference t)
ImagingStudy.ImagingStudySeriesInstanceComponent	addInstance()
ImagingStudy.ImagingStudySeriesComponent	addInstance(ImagingStudy.ImagingStudySeriesInstanceComponent t)
ImagingStudy.ImagingStudySeriesPerformerComponent	addPerformer()
ImagingStudy.ImagingStudySeriesComponent	addPerformer(ImagingStudy.ImagingStudySeriesPerformerComponent t)
Reference	addSpecimen()
ImagingStudy.ImagingStudySeriesComponent	addSpecimen(Reference t)
ImagingStudy.ImagingStudySeriesComponent	copy()
void	copyValues(ImagingStudy.ImagingStudySeriesComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableReference	getBodySite()
String	getDescription()
StringType	getDescriptionElement()
List<Reference>	getEndpoint()
Reference	getEndpointFirstRep()
List<ImagingStudy.ImagingStudySeriesInstanceComponent>	getInstance()
ImagingStudy.ImagingStudySeriesInstanceComponent	getInstanceFirstRep()
CodeableConcept	getLaterality()
CodeableConcept	getModality()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
int	getNumber()
UnsignedIntType	getNumberElement()
int	getNumberOfInstances()
UnsignedIntType	getNumberOfInstancesElement()
List<ImagingStudy.ImagingStudySeriesPerformerComponent>	getPerformer()
ImagingStudy.ImagingStudySeriesPerformerComponent	getPerformerFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getSpecimen()
Reference	getSpecimenFirstRep()
Date	getStarted()
DateTimeType	getStartedElement()
String[]	getTypesForProperty(int hash, String name)
String	getUid()
IdType	getUidElement()
boolean	hasBodySite()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEndpoint()
boolean	hasInstance()
boolean	hasLaterality()
boolean	hasModality()
boolean	hasNumber()
boolean	hasNumberElement()
boolean	hasNumberOfInstances()
boolean	hasNumberOfInstancesElement()
boolean	hasPerformer()
boolean	hasSpecimen()
boolean	hasStarted()
boolean	hasStartedElement()
boolean	hasUid()
boolean	hasUidElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ImagingStudy.ImagingStudySeriesComponent	setBodySite(CodeableReference value)
ImagingStudy.ImagingStudySeriesComponent	setDescription(String value)
ImagingStudy.ImagingStudySeriesComponent	setDescriptionElement(StringType value)
ImagingStudy.ImagingStudySeriesComponent	setEndpoint(List<Reference> theEndpoint)
ImagingStudy.ImagingStudySeriesComponent	setInstance(List<ImagingStudy.ImagingStudySeriesInstanceComponent> theInstance)
ImagingStudy.ImagingStudySeriesComponent	setLaterality(CodeableConcept value)
ImagingStudy.ImagingStudySeriesComponent	setModality(CodeableConcept value)
ImagingStudy.ImagingStudySeriesComponent	setNumber(int value)
ImagingStudy.ImagingStudySeriesComponent	setNumberElement(UnsignedIntType value)
ImagingStudy.ImagingStudySeriesComponent	setNumberOfInstances(int value)
ImagingStudy.ImagingStudySeriesComponent	setNumberOfInstancesElement(UnsignedIntType value)
ImagingStudy.ImagingStudySeriesComponent	setPerformer(List<ImagingStudy.ImagingStudySeriesPerformerComponent> thePerformer)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ImagingStudy.ImagingStudySeriesComponent	setSpecimen(List<Reference> theSpecimen)
ImagingStudy.ImagingStudySeriesComponent	setStarted(Date value)
ImagingStudy.ImagingStudySeriesComponent	setStartedElement(DateTimeType value)
ImagingStudy.ImagingStudySeriesComponent	setUid(String value)
ImagingStudy.ImagingStudySeriesComponent	setUidElement(IdType value)

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

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

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, 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, 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

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 DICOM Series Instance UID for the series.

number

protected UnsignedIntType number

The numeric identifier of this series in the study.

modality

protected CodeableConcept modality

The distinct modality for this series. This may include both acquisition and non-acquisition modalities.

description

protected StringType description

A description of the series.

numberOfInstances

protected UnsignedIntType 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.

endpoint

protected List<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.

bodySite

protected CodeableReference 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.

laterality

protected CodeableConcept 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.

specimen

protected List<Reference> specimen

The specimen imaged, e.g., for whole slide imaging of a biopsy.

started

protected DateTimeType started

The date and time the series was started.

performer

protected List<ImagingStudy.ImagingStudySeriesPerformerComponent> performer

Indicates who or what performed the series and how they were involved.

instance

protected List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance

A single SOP instance within the series, e.g. an image, or presentation state.

Constructor Details

ImagingStudySeriesComponent

public ImagingStudySeriesComponent()

Constructor

ImagingStudySeriesComponent

public ImagingStudySeriesComponent(String uid,
 CodeableConcept modality)

Constructor

Method Details

getUidElement

public IdType getUidElement()

Returns:

uid (The DICOM Series Instance UID for the 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(IdType value)

Parameters:

value - uid (The DICOM Series Instance UID for the 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:

The DICOM Series Instance UID for the series.

setUid

public ImagingStudy.ImagingStudySeriesComponent setUid(String value)

Parameters:

value - The DICOM Series Instance UID for the 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 CodeableConcept getModality()

Returns:

modality (The distinct modality for this series. This may include both acquisition and non-acquisition modalities.)

hasModality

public boolean hasModality()

setModality

public ImagingStudy.ImagingStudySeriesComponent setModality(CodeableConcept value)

Parameters:

value - modality (The distinct modality for this series. This may include both acquisition and non-acquisition modalities.)

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

setNumberOfInstances

public ImagingStudy.ImagingStudySeriesComponent setNumberOfInstances(int value)

Parameters:

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

getEndpoint

public List<Reference> getEndpoint()

Returns:

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

setEndpoint

public ImagingStudy.ImagingStudySeriesComponent setEndpoint(List<Reference> theEndpoint)

Returns:

Returns a reference to this for easy method chaining

hasEndpoint

public boolean hasEndpoint()

addEndpoint

public Reference addEndpoint()

addEndpoint

public ImagingStudy.ImagingStudySeriesComponent addEndpoint(Reference t)

getEndpointFirstRep

public Reference getEndpointFirstRep()

Returns:

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

getBodySite

public CodeableReference getBodySite()

Returns:

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

hasBodySite

public boolean hasBodySite()

setBodySite

public ImagingStudy.ImagingStudySeriesComponent setBodySite(CodeableReference value)

Parameters:

value - 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.)

getLaterality

public CodeableConcept getLaterality()

Returns:

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

hasLaterality

public boolean hasLaterality()

setLaterality

public ImagingStudy.ImagingStudySeriesComponent setLaterality(CodeableConcept value)

Parameters:

value - 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.)

getSpecimen

public List<Reference> getSpecimen()

Returns:

specimen (The specimen imaged, e.g., for whole slide imaging of a biopsy.)

setSpecimen

public ImagingStudy.ImagingStudySeriesComponent setSpecimen(List<Reference> theSpecimen)

Returns:

Returns a reference to this for easy method chaining

hasSpecimen

public boolean hasSpecimen()

addSpecimen

public Reference addSpecimen()

addSpecimen

public ImagingStudy.ImagingStudySeriesComponent addSpecimen(Reference t)

getSpecimenFirstRep

public Reference getSpecimenFirstRep()

Returns:

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

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.

getPerformer

public List<ImagingStudy.ImagingStudySeriesPerformerComponent> getPerformer()

Returns:

performer (Indicates who or what performed the series and how they were involved.)

setPerformer

public ImagingStudy.ImagingStudySeriesComponent setPerformer(List<ImagingStudy.ImagingStudySeriesPerformerComponent> thePerformer)

Returns:

Returns a reference to this for easy method chaining

hasPerformer

public boolean hasPerformer()

addPerformer

public ImagingStudy.ImagingStudySeriesPerformerComponent addPerformer()

addPerformer

public ImagingStudy.ImagingStudySeriesComponent addPerformer(ImagingStudy.ImagingStudySeriesPerformerComponent t)

getPerformerFirstRep

public ImagingStudy.ImagingStudySeriesPerformerComponent getPerformerFirstRep()

Returns:

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

getInstance

public List<ImagingStudy.ImagingStudySeriesInstanceComponent> getInstance()

Returns:

instance (A single SOP instance within the series, e.g. an image, or presentation state.)

setInstance

public ImagingStudy.ImagingStudySeriesComponent setInstance(List<ImagingStudy.ImagingStudySeriesInstanceComponent> theInstance)

Returns:

Returns a reference to this for easy method chaining

hasInstance

public boolean hasInstance()

addInstance

public ImagingStudy.ImagingStudySeriesInstanceComponent addInstance()

addInstance

public ImagingStudy.ImagingStudySeriesComponent addInstance(ImagingStudy.ImagingStudySeriesInstanceComponent t)

getInstanceFirstRep

public ImagingStudy.ImagingStudySeriesInstanceComponent getInstanceFirstRep()

Returns:

The first repetition of repeating field instance, 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 ImagingStudy.ImagingStudySeriesComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ImagingStudy.ImagingStudySeriesComponent 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)