
Package org.hl7.fhir.dstu3.model
Class ImagingStudy.ImagingStudySeriesComponent
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.BackboneElement
-
- org.hl7.fhir.dstu3.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
-
-
Field Summary
Fields Modifier and Type Field Description protected Enumeration<ImagingStudy.InstanceAvailability>
availability
Availability of series (online, offline or nearline).protected Coding
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<Endpoint>
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.protected List<ImagingStudy.ImagingStudySeriesInstanceComponent>
instance
A single SOP instance within the series, e.g.protected Coding
laterality
The laterality of the (possibly paired) anatomic structures examined.protected Coding
modality
The modality of this series sequence.protected UnsignedIntType
number
The numeric identifier of this series in the study.protected UnsignedIntType
numberOfInstances
Number of SOP Instances in the Study.protected List<Reference>
performer
The physician or operator (often the radiology technician) who performed the series.protected List<Practitioner>
performerTarget
The actual objects that are the target of the reference (The physician or operator (often the radiology technician) who performed the series.protected DateTimeType
started
The date and time the series was started.protected OidType
uid
Formal identifier for this series.-
Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description ImagingStudySeriesComponent()
ConstructorImagingStudySeriesComponent(OidType uid, Coding modality)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
number
protected UnsignedIntType number
The numeric identifier of this series in the study.
-
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.
-
availability
protected Enumeration<ImagingStudy.InstanceAvailability> availability
Availability of series (online, offline or nearline).
-
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.type.
-
endpointTarget
protected List<Endpoint> 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.type.)
-
bodySite
protected 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.
-
laterality
protected 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.
-
started
protected DateTimeType started
The date and time the series was started.
-
performer
protected List<Reference> performer
The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.
-
performerTarget
protected List<Practitioner> performerTarget
The actual objects that are the target of the reference (The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.)
-
instance
protected List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance
A single SOP instance within the series, e.g. an image, or presentation state.
-
-
Constructor Detail
-
ImagingStudySeriesComponent
public ImagingStudySeriesComponent()
Constructor
-
ImagingStudySeriesComponent
public ImagingStudySeriesComponent(OidType uid, Coding modality)
Constructor
-
-
Method Detail
-
getUidElement
public OidType getUidElement()
- Returns:
uid
(Formal identifier for this 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(OidType value)
- Parameters:
value
-uid
(Formal identifier for this series.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
-
setUid
public ImagingStudy.ImagingStudySeriesComponent setUid(String value)
- Parameters:
value
- Formal identifier for this 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 Coding getModality()
- Returns:
modality
(The modality of this series sequence.)
-
hasModality
public boolean hasModality()
-
setModality
public ImagingStudy.ImagingStudySeriesComponent setModality(Coding value)
- Parameters:
value
-modality
(The modality of this series sequence.)
-
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.
-
getAvailabilityElement
public Enumeration<ImagingStudy.InstanceAvailability> getAvailabilityElement()
- Returns:
availability
(Availability of series (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
-
hasAvailabilityElement
public boolean hasAvailabilityElement()
-
hasAvailability
public boolean hasAvailability()
-
setAvailabilityElement
public ImagingStudy.ImagingStudySeriesComponent setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)
- Parameters:
value
-availability
(Availability of series (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
-
getAvailability
public ImagingStudy.InstanceAvailability getAvailability()
- Returns:
- Availability of series (online, offline or nearline).
-
setAvailability
public ImagingStudy.ImagingStudySeriesComponent setAvailability(ImagingStudy.InstanceAvailability value)
- Parameters:
value
- Availability of series (online, offline or nearline).
-
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.type.)
-
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
-
getEndpointTarget
@Deprecated public List<Endpoint> getEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEndpointTarget
@Deprecated public Endpoint addEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBodySite
public Coding 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(Coding 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 Coding 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(Coding 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.)
-
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<Reference> getPerformer()
- Returns:
performer
(The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.)
-
setPerformer
public ImagingStudy.ImagingStudySeriesComponent setPerformer(List<Reference> thePerformer)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public Reference addPerformer()
-
addPerformer
public ImagingStudy.ImagingStudySeriesComponent addPerformer(Reference t)
-
getPerformerFirstRep
public Reference getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getPerformerTarget
@Deprecated public List<Practitioner> getPerformerTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addPerformerTarget
@Deprecated public Practitioner addPerformerTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public ImagingStudy.ImagingStudySeriesComponent copy()
- Specified by:
copy
in classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-
-