Class ImagingStudy
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.ImagingStudy
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class ImagingStudy extends DomainResource
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImagingStudy.Builder
static class
ImagingStudy.Series
Each study has one or more series of images or other content.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ImagingStudy.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<Reference>
getBasedOn()
A list of the diagnostic requests that resulted in this imaging study being performed.String
getDescription()
The Imaging Manager description of the study.Reference
getEncounter()
The healthcare event (e.g.java.util.List<Reference>
getEndpoint()
The network service providing access (e.g., query, view, or retrieval) for the study.java.util.List<Identifier>
getIdentifier()
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.java.util.List<Reference>
getInterpreter()
Who read the study and interpreted the images or other content.Reference
getLocation()
The principal physical location where the ImagingStudy was performed.java.util.List<Coding>
getModality()
A list of all the series.modality values that are actual acquisition modalities, i.e.java.util.List<Annotation>
getNote()
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030).UnsignedInt
getNumberOfInstances()
Number of SOP Instances in Study.UnsignedInt
getNumberOfSeries()
Number of Series in the Study.java.util.List<CodeableConcept>
getProcedureCode()
The code for the performed procedure type.Reference
getProcedureReference()
The procedure which this ImagingStudy was part of.java.util.List<CodeableConcept>
getReasonCode()
Description of clinical condition indicating why the ImagingStudy was requested.java.util.List<Reference>
getReasonReference()
Indicates another resource whose existence justifies this Study.Reference
getReferrer()
The requesting/referring physician.java.util.List<ImagingStudy.Series>
getSeries()
Each study has one or more series of images or other content.DateTime
getStarted()
Date and time the study started.ImagingStudyStatus
getStatus()
The current state of the ImagingStudy.Reference
getSubject()
The subject, typically a patient, of the imaging study.boolean
hasChildren()
int
hashCode()
ImagingStudy.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public ImagingStudyStatus getStatus()
The current state of the ImagingStudy.- Returns:
- An immutable object of type
ImagingStudyStatus
that is non-null.
-
getModality
public java.util.List<Coding> getModality()
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).- Returns:
- An unmodifiable list containing immutable objects of type
Coding
that may be empty.
-
getSubject
public Reference getSubject()
The subject, typically a patient, of the imaging study.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getEncounter
public Reference getEncounter()
The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.- Returns:
- An immutable object of type
Reference
that may be null.
-
getStarted
public DateTime getStarted()
Date and time the study started.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getBasedOn
public java.util.List<Reference> getBasedOn()
A list of the diagnostic requests that resulted in this imaging study being performed.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getReferrer
public Reference getReferrer()
The requesting/referring physician.- Returns:
- An immutable object of type
Reference
that may be null.
-
getInterpreter
public java.util.List<Reference> getInterpreter()
Who read the study and interpreted the images or other content.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getEndpoint
public java.util.List<Reference> getEndpoint()
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getNumberOfSeries
public UnsignedInt getNumberOfSeries()
Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.- Returns:
- An immutable object of type
UnsignedInt
that may be null.
-
getNumberOfInstances
public UnsignedInt getNumberOfInstances()
Number of SOP Instances in Study. This 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.- Returns:
- An immutable object of type
UnsignedInt
that may be null.
-
getProcedureReference
public Reference getProcedureReference()
The procedure which this ImagingStudy was part of.- Returns:
- An immutable object of type
Reference
that may be null.
-
getProcedureCode
public java.util.List<CodeableConcept> getProcedureCode()
The code for the performed procedure type.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getLocation
public Reference getLocation()
The principal physical location where the ImagingStudy was performed.- Returns:
- An immutable object of type
Reference
that may be null.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
Description of clinical condition indicating why the ImagingStudy was requested.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Indicates another resource whose existence justifies this Study.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getDescription
public String getDescription()
The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.- Returns:
- An immutable object of type
String
that may be null.
-
getSeries
public java.util.List<ImagingStudy.Series> getSeries()
Each study has one or more series of images or other content.- Returns:
- An unmodifiable list containing immutable objects of type
ImagingStudy.Series
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ImagingStudy.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static ImagingStudy.Builder builder()
-
-