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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Enumeration
<ImagingStudy.InstanceAvailability> Availability of series (online, offline or nearline).protected 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.The physician or operator (often the radiology technician) who performed the series.protected List
<Practitioner> The actual objects that are the target of the reference (The physician or operator (often the radiology technician) who performed the series.protected DateTimeType
The date and time the series was started.protected OidType
Formal identifier for this series.Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
Constructor Summary
ConstructorDescriptionConstructorImagingStudySeriesComponent
(OidType uid, Coding modality) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) int
int
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) getUid()
boolean
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) 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<Reference> thePerformer) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStarted
(Date value) setStartedElement
(DateTimeType value) setUidElement
(OidType value) 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, getExtensionByUrl, 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
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
Formal identifier for this 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. -
availability
Availability of series (online, offline or nearline). -
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
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
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. -
started
The date and time the series was started. -
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
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
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
(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
-
hasUid
-
setUidElement
- 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
-
getUid
- Returns:
- Formal identifier for this series.
-
setUid
- Parameters:
value
- Formal identifier for this 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.
-
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
-
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
- 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
- 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
- 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.)
-
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
(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
- 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
-
getPerformerTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addPerformerTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
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
-
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
-