Package org.hl7.fhir.r4.model
Class ImagingStudy.ImagingStudySeriesComponent
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.BackboneElement
org.hl7.fhir.r4.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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Coding
The anatomic structures examined.protected StringType
A description of the series.The network service providing access (e.g., query, view, or retrieval) for this series.The actual objects that are the target of the reference (The network service providing access (e.g., query, view, or retrieval) for this series.A single SOP instance within the series, e.g.protected Coding
The laterality of the (possibly paired) anatomic structures examined.protected Coding
The modality of this series sequence.protected UnsignedIntType
The numeric identifier of this series in the study.protected UnsignedIntType
Number of SOP Instances in the Study.Indicates who or what performed the series and how they were involved.The specimen imaged, e.g., for whole slide imaging of a biopsy.The actual objects that are the target of the reference (The specimen imaged, e.g., for whole slide imaging of a biopsy.)protected DateTimeType
The date and time the series was started.protected IdType
The DICOM Series Instance UID for the series.Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension
-
Constructor Summary
ConstructorDescriptionConstructorImagingStudySeriesComponent
(IdType uid, Coding modality) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) int
int
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) getUid()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasUid()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setBodySite
(Coding value) setDescription
(String value) setDescriptionElement
(StringType value) setEndpoint
(List<Reference> theEndpoint) setInstance
(List<ImagingStudy.ImagingStudySeriesInstanceComponent> theInstance) setLaterality
(Coding value) setModality
(Coding value) setNumber
(int value) setNumberElement
(UnsignedIntType value) setNumberOfInstances
(int value) setPerformer
(List<ImagingStudy.ImagingStudySeriesPerformerComponent> thePerformer) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSpecimen
(List<Reference> theSpecimen) setStarted
(Date value) setStartedElement
(DateTimeType value) setUidElement
(IdType value) Methods inherited from class org.hl7.fhir.r4.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.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, 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
The DICOM Series Instance UID for the series. -
number
The numeric identifier of this series in the study. -
modality
The modality of this series sequence. -
description
A description of the series. -
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
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. -
endpointTarget
The actual objects that are the target of the reference (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
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
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
The specimen imaged, e.g., for whole slide imaging of a biopsy. -
specimenTarget
The actual objects that are the target of the reference (The specimen imaged, e.g., for whole slide imaging of a biopsy.) -
started
The date and time the series was started. -
performer
Indicates who or what performed the series and how they were involved. -
instance
A single SOP instance within the series, e.g. an image, or presentation state.
-
-
Constructor Details
-
ImagingStudySeriesComponent
public ImagingStudySeriesComponent()Constructor -
ImagingStudySeriesComponent
Constructor
-
-
Method Details
-
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
-
hasUid
-
setUidElement
- 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
- Returns:
- The DICOM Series Instance UID for the series.
-
setUid
- Parameters:
value
- The DICOM Series Instance UID for the series.
-
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
-
hasNumber
-
setNumberElement
- 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
- Returns:
- The numeric identifier of this series in the study.
-
setNumber
- Parameters:
value
- The numeric identifier of this series in the study.
-
getModality
- Returns:
modality
(The modality of this series sequence.)
-
hasModality
-
setModality
- Parameters:
value
-modality
(The modality of this series sequence.)
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- A description of the series.
-
setDescription
- Parameters:
value
- A description of the series.
-
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
-
hasNumberOfInstances
-
setNumberOfInstancesElement
- 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
- 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
- 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
- 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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEndpoint
-
addEndpoint
-
addEndpoint
-
getEndpointFirstRep
- Returns:
- The first repetition of repeating field
endpoint
, creating it if it does not already exist
-
getEndpointTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEndpointTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
setBodySite
- 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
- 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
-
setLaterality
- 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
- Returns:
specimen
(The specimen imaged, e.g., for whole slide imaging of a biopsy.)
-
setSpecimen
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecimen
-
addSpecimen
-
addSpecimen
-
getSpecimenFirstRep
- Returns:
- The first repetition of repeating field
specimen
, creating it if it does not already exist
-
getSpecimenTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSpecimenTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
hasStarted
-
setStartedElement
- 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
- Returns:
- The date and time the series was started.
-
setStarted
- Parameters:
value
- The date and time the series was started.
-
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
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
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
-
addInstance
-
addInstance
-
getInstanceFirstRep
- Returns:
- The first repetition of repeating field
instance
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-