Package org.hl7.fhir.dstu2.model
Class ImagingStudy
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.ImagingStudy
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImagingStudy.ImagingStudySeriesComponentstatic classImagingStudy.ImagingStudySeriesInstanceComponentstatic classImagingStudy.InstanceAvailabilitystatic classImagingStudy.InstanceAvailabilityEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected IdentifieraccessionAccession Number is an identifier related to some aspect of imaging workflow and data management.protected Enumeration<ImagingStudy.InstanceAvailability>availabilityAvailability of study (online, offline or nearline).protected StringTypedescriptionInstitution-generated description or classification of the Study performed.protected List<Identifier>identifierOther identifiers for the study.protected ReferenceinterpreterWho read the study and interpreted the images or other content.protected PractitionerinterpreterTargetThe actual object that is the target of the reference (Who read the study and interpreted the images or other content.)protected List<Coding>modalityListA list of all the Series.ImageModality values that are actual acquisition modalities, i.e.protected UnsignedIntTypenumberOfInstancesNumber of SOP Instances in Study.protected UnsignedIntTypenumberOfSeriesNumber of Series in Study.protected List<Reference>orderA list of the diagnostic orders that resulted in this imaging study being performed.protected List<DiagnosticOrder>orderTargetThe actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.)protected ReferencepatientThe patient imaged in the study.protected PatientpatientTargetThe actual object that is the target of the reference (The patient imaged in the study.)protected List<Reference>procedureType of procedure performed.protected List<Procedure>procedureTargetThe actual objects that are the target of the reference (Type of procedure performed.)protected ReferencereferrerThe requesting/referring physician.protected PractitionerreferrerTargetThe actual object that is the target of the reference (The requesting/referring physician.)protected List<ImagingStudy.ImagingStudySeriesComponent>seriesEach study has one or more series of images or other content.static StringSP_ACCESSIONstatic StringSP_BODYSITEstatic StringSP_DICOMCLASSstatic StringSP_MODALITYstatic StringSP_ORDERstatic StringSP_PATIENTstatic StringSP_SERIESstatic StringSP_STARTEDstatic StringSP_STUDYstatic StringSP_UIDprotected DateTimeTypestartedDate and Time the study started.protected OidTypeuidFormal identifier for the study.protected UriTypeurlWADO-RS resource where Study is available.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImagingStudy()ImagingStudy(Reference patient, OidType uid, UnsignedIntType numberOfSeries, UnsignedIntType numberOfInstances)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
started
protected DateTimeType started
Date and Time the study started.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The patient imaged in the study.)
-
accession
protected Identifier accession
Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
-
identifier
protected List<Identifier> identifier
Other identifiers for the study.
-
order
protected List<Reference> order
A list of the diagnostic orders that resulted in this imaging study being performed.
-
orderTarget
protected List<DiagnosticOrder> orderTarget
The actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.)
-
modalityList
protected List<Coding> modalityList
A list of all the Series.ImageModality 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).
-
referrerTarget
protected Practitioner referrerTarget
The actual object that is the target of the reference (The requesting/referring physician.)
-
availability
protected Enumeration<ImagingStudy.InstanceAvailability> availability
Availability of study (online, offline or nearline).
-
numberOfSeries
protected UnsignedIntType numberOfSeries
Number of Series in Study.
-
numberOfInstances
protected UnsignedIntType numberOfInstances
Number of SOP Instances in Study.
-
procedureTarget
protected List<Procedure> procedureTarget
The actual objects that are the target of the reference (Type of procedure performed.)
-
interpreter
protected Reference interpreter
Who read the study and interpreted the images or other content.
-
interpreterTarget
protected Practitioner interpreterTarget
The actual object that is the target of the reference (Who read the study and interpreted the images or other content.)
-
description
protected StringType description
Institution-generated description or classification of the Study performed.
-
series
protected List<ImagingStudy.ImagingStudySeriesComponent> series
Each study has one or more series of images or other content.
-
SP_UID
public static final String SP_UID
- See Also:
- Constant Field Values
-
SP_STUDY
public static final String SP_STUDY
- See Also:
- Constant Field Values
-
SP_DICOMCLASS
public static final String SP_DICOMCLASS
- See Also:
- Constant Field Values
-
SP_MODALITY
public static final String SP_MODALITY
- See Also:
- Constant Field Values
-
SP_BODYSITE
public static final String SP_BODYSITE
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_SERIES
public static final String SP_SERIES
- See Also:
- Constant Field Values
-
SP_STARTED
public static final String SP_STARTED
- See Also:
- Constant Field Values
-
SP_ACCESSION
public static final String SP_ACCESSION
- See Also:
- Constant Field Values
-
SP_ORDER
public static final String SP_ORDER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ImagingStudy
public ImagingStudy()
-
ImagingStudy
public ImagingStudy(Reference patient, OidType uid, UnsignedIntType numberOfSeries, UnsignedIntType numberOfInstances)
-
-
Method Detail
-
getStartedElement
public DateTimeType getStartedElement()
- Returns:
started(Date and Time the study 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 setStartedElement(DateTimeType value)
- Parameters:
value-started(Date and Time the study 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:
- Date and Time the study started.
-
setStarted
public ImagingStudy setStarted(Date value)
- Parameters:
value- Date and Time the study started.
-
getPatient
public Reference getPatient()
- Returns:
patient(The patient imaged in the study.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public ImagingStudy setPatient(Reference value)
- Parameters:
value-patient(The patient imaged in the study.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient imaged in the study.)
-
setPatientTarget
public ImagingStudy setPatientTarget(Patient value)
- Parameters:
value-patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient imaged in the study.)
-
getUidElement
public OidType getUidElement()
- Returns:
uid(Formal identifier for the study.). 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 setUidElement(OidType value)
- Parameters:
value-uid(Formal identifier for the study.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
-
setUid
public ImagingStudy setUid(String value)
- Parameters:
value- Formal identifier for the study.
-
getAccession
public Identifier getAccession()
- Returns:
accession(Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)
-
hasAccession
public boolean hasAccession()
-
setAccession
public ImagingStudy setAccession(Identifier value)
- Parameters:
value-accession(Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Other identifiers for the study.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(Other identifiers for the study.)
-
addIdentifier
public ImagingStudy addIdentifier(Identifier t)
-
getOrder
public List<Reference> getOrder()
- Returns:
order(A list of the diagnostic orders that resulted in this imaging study being performed.)
-
hasOrder
public boolean hasOrder()
-
addOrder
public Reference addOrder()
- Returns:
order(A list of the diagnostic orders that resulted in this imaging study being performed.)
-
addOrder
public ImagingStudy addOrder(Reference t)
-
getOrderTarget
public List<DiagnosticOrder> getOrderTarget()
- Returns:
order(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A list of the diagnostic orders that resulted in this imaging study being performed.)
-
addOrderTarget
public DiagnosticOrder addOrderTarget()
- Returns:
order(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. A list of the diagnostic orders that resulted in this imaging study being performed.)
-
getModalityList
public List<Coding> getModalityList()
- Returns:
modalityList(A list of all the Series.ImageModality 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).)
-
hasModalityList
public boolean hasModalityList()
-
addModalityList
public Coding addModalityList()
- Returns:
modalityList(A list of all the Series.ImageModality 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).)
-
addModalityList
public ImagingStudy addModalityList(Coding t)
-
getReferrer
public Reference getReferrer()
- Returns:
referrer(The requesting/referring physician.)
-
hasReferrer
public boolean hasReferrer()
-
setReferrer
public ImagingStudy setReferrer(Reference value)
- Parameters:
value-referrer(The requesting/referring physician.)
-
getReferrerTarget
public Practitioner getReferrerTarget()
- Returns:
referrerThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)
-
setReferrerTarget
public ImagingStudy setReferrerTarget(Practitioner value)
- Parameters:
value-referrerThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)
-
getAvailabilityElement
public Enumeration<ImagingStudy.InstanceAvailability> getAvailabilityElement()
- Returns:
availability(Availability of study (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 setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)
- Parameters:
value-availability(Availability of study (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 study (online, offline or nearline).
-
setAvailability
public ImagingStudy setAvailability(ImagingStudy.InstanceAvailability value)
- Parameters:
value- Availability of study (online, offline or nearline).
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(WADO-RS resource where Study is available.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public ImagingStudy setUrlElement(UriType value)
- Parameters:
value-url(WADO-RS resource where Study is available.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
setUrl
public ImagingStudy setUrl(String value)
- Parameters:
value- WADO-RS resource where Study is available.
-
getNumberOfSeriesElement
public UnsignedIntType getNumberOfSeriesElement()
- Returns:
numberOfSeries(Number of Series in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the value
-
hasNumberOfSeriesElement
public boolean hasNumberOfSeriesElement()
-
hasNumberOfSeries
public boolean hasNumberOfSeries()
-
setNumberOfSeriesElement
public ImagingStudy setNumberOfSeriesElement(UnsignedIntType value)
- Parameters:
value-numberOfSeries(Number of Series in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the value
-
getNumberOfSeries
public int getNumberOfSeries()
- Returns:
- Number of Series in Study.
-
setNumberOfSeries
public ImagingStudy setNumberOfSeries(int value)
- Parameters:
value- Number of Series in Study.
-
getNumberOfInstancesElement
public UnsignedIntType getNumberOfInstancesElement()
- Returns:
numberOfInstances(Number of SOP Instances in Study.). 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 setNumberOfInstancesElement(UnsignedIntType value)
- Parameters:
value-numberOfInstances(Number of SOP Instances in Study.). 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 Study.
-
setNumberOfInstances
public ImagingStudy setNumberOfInstances(int value)
- Parameters:
value- Number of SOP Instances in Study.
-
getProcedure
public List<Reference> getProcedure()
- Returns:
procedure(Type of procedure performed.)
-
hasProcedure
public boolean hasProcedure()
-
addProcedure
public Reference addProcedure()
- Returns:
procedure(Type of procedure performed.)
-
addProcedure
public ImagingStudy addProcedure(Reference t)
-
getProcedureTarget
public List<Procedure> getProcedureTarget()
- Returns:
procedure(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Type of procedure performed.)
-
addProcedureTarget
public Procedure addProcedureTarget()
- Returns:
procedure(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Type of procedure performed.)
-
getInterpreter
public Reference getInterpreter()
- Returns:
interpreter(Who read the study and interpreted the images or other content.)
-
hasInterpreter
public boolean hasInterpreter()
-
setInterpreter
public ImagingStudy setInterpreter(Reference value)
- Parameters:
value-interpreter(Who read the study and interpreted the images or other content.)
-
getInterpreterTarget
public Practitioner getInterpreterTarget()
- Returns:
interpreterThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Who read the study and interpreted the images or other content.)
-
setInterpreterTarget
public ImagingStudy setInterpreterTarget(Practitioner value)
- Parameters:
value-interpreterThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Who read the study and interpreted the images or other content.)
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(Institution-generated description or classification of the Study performed.). 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 setDescriptionElement(StringType value)
- Parameters:
value-description(Institution-generated description or classification of the Study performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- Institution-generated description or classification of the Study performed.
-
setDescription
public ImagingStudy setDescription(String value)
- Parameters:
value- Institution-generated description or classification of the Study performed.
-
getSeries
public List<ImagingStudy.ImagingStudySeriesComponent> getSeries()
- Returns:
series(Each study has one or more series of images or other content.)
-
hasSeries
public boolean hasSeries()
-
addSeries
public ImagingStudy.ImagingStudySeriesComponent addSeries()
- Returns:
series(Each study has one or more series of images or other content.)
-
addSeries
public ImagingStudy addSeries(ImagingStudy.ImagingStudySeriesComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ImagingStudy copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected ImagingStudy typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-