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
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Identifier
Accession Number is an identifier related to some aspect of imaging workflow and data management.protected Enumeration
<ImagingStudy.InstanceAvailability> Availability of study (online, offline or nearline).protected StringType
Institution-generated description or classification of the Study performed.protected List
<Identifier> Other identifiers for the study.protected Reference
Who read the study and interpreted the images or other content.protected Practitioner
The actual object that is the target of the reference (Who read the study and interpreted the images or other content.)A list of all the Series.ImageModality values that are actual acquisition modalities, i.e.protected UnsignedIntType
Number of SOP Instances in Study.protected UnsignedIntType
Number of Series in Study.A list of the diagnostic orders that resulted in this imaging study being performed.protected List
<DiagnosticOrder> The actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.)protected Reference
The patient imaged in the study.protected Patient
The actual object that is the target of the reference (The patient imaged in the study.)Type of procedure performed.The actual objects that are the target of the reference (Type of procedure performed.)protected Reference
The requesting/referring physician.protected Practitioner
The actual object that is the target of the reference (The requesting/referring physician.)protected List
<ImagingStudy.ImagingStudySeriesComponent> Each study has one or more series of images or other content.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected DateTimeType
Date and Time the study started.protected OidType
Formal identifier for the study.protected UriType
WADO-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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionImagingStudy
(Reference patient, OidType uid, UnsignedIntType numberOfSeries, UnsignedIntType numberOfInstances) -
Method Summary
Modifier and TypeMethodDescriptionaddOrder()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
int
int
getOrder()
getUid()
getUrl()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasOrder()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasUid()
boolean
boolean
hasUrl()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setAccession
(Identifier value) setDescription
(String value) setDescriptionElement
(StringType value) setInterpreter
(Reference value) setInterpreterTarget
(Practitioner value) setNumberOfInstances
(int value) setNumberOfSeries
(int value) setPatient
(Reference value) setPatientTarget
(Patient value) void
setProperty
(String name, Base value) setReferrer
(Reference value) setReferrerTarget
(Practitioner value) setStarted
(Date value) setStartedElement
(DateTimeType value) setUidElement
(OidType value) setUrlElement
(UriType value) protected ImagingStudy
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
started
Date and Time the study started. -
patient
The patient imaged in the study. -
patientTarget
The actual object that is the target of the reference (The patient imaged in the study.) -
uid
Formal identifier for the study. -
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
Other identifiers for the study. -
order
A list of the diagnostic orders that resulted in this imaging study being performed. -
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
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). -
referrer
The requesting/referring physician. -
referrerTarget
The actual object that is the target of the reference (The requesting/referring physician.) -
availability
Availability of study (online, offline or nearline). -
url
WADO-RS resource where Study is available. -
numberOfSeries
Number of Series in Study. -
numberOfInstances
Number of SOP Instances in Study. -
procedure
Type of procedure performed. -
procedureTarget
The actual objects that are the target of the reference (Type of procedure performed.) -
interpreter
Who read the study and interpreted the images or other content. -
interpreterTarget
The actual object that is the target of the reference (Who read the study and interpreted the images or other content.) -
description
Institution-generated description or classification of the Study performed. -
series
Each study has one or more series of images or other content. -
SP_UID
- See Also:
-
SP_STUDY
- See Also:
-
SP_DICOMCLASS
- See Also:
-
SP_MODALITY
- See Also:
-
SP_BODYSITE
- See Also:
-
SP_PATIENT
- See Also:
-
SP_SERIES
- See Also:
-
SP_STARTED
- See Also:
-
SP_ACCESSION
- See Also:
-
SP_ORDER
- See Also:
-
-
Constructor Details
-
ImagingStudy
public ImagingStudy() -
ImagingStudy
public ImagingStudy(Reference patient, OidType uid, UnsignedIntType numberOfSeries, UnsignedIntType numberOfInstances)
-
-
Method Details
-
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
-
hasStarted
-
setStartedElement
- 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
- Returns:
- Date and Time the study started.
-
setStarted
- Parameters:
value
- Date and Time the study started.
-
getPatient
- Returns:
patient
(The patient imaged in the study.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(The patient imaged in the study.)
-
getPatientTarget
- Returns:
patient
The 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
- Parameters:
value
-patient
The 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
- 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
-
hasUid
-
setUidElement
- 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
-
getUid
- Returns:
- Formal identifier for the study.
-
setUid
- Parameters:
value
- Formal identifier for the study.
-
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
-
setAccession
- 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
- Returns:
identifier
(Other identifiers for the study.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier
(Other identifiers for the study.)
-
addIdentifier
-
getOrder
- Returns:
order
(A list of the diagnostic orders that resulted in this imaging study being performed.)
-
hasOrder
-
addOrder
- Returns:
order
(A list of the diagnostic orders that resulted in this imaging study being performed.)
-
addOrder
-
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
- 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
- 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
-
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
-
getReferrer
- Returns:
referrer
(The requesting/referring physician.)
-
hasReferrer
-
setReferrer
- Parameters:
value
-referrer
(The requesting/referring physician.)
-
getReferrerTarget
- Returns:
referrer
The 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
- Parameters:
value
-referrer
The 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
- 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
-
hasAvailability
-
setAvailabilityElement
- 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
- Returns:
- Availability of study (online, offline or nearline).
-
setAvailability
- Parameters:
value
- Availability of study (online, offline or nearline).
-
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
-
hasUrl
-
setUrlElement
- 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
-
getUrl
- Returns:
- WADO-RS resource where Study is available.
-
setUrl
- Parameters:
value
- WADO-RS resource where Study is available.
-
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
-
hasNumberOfSeries
-
setNumberOfSeriesElement
- 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
- Returns:
- Number of Series in Study.
-
setNumberOfSeries
- Parameters:
value
- Number of Series in Study.
-
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
-
hasNumberOfInstances
-
setNumberOfInstancesElement
- 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
- Returns:
- Number of SOP Instances in Study.
-
setNumberOfInstances
- Parameters:
value
- Number of SOP Instances in Study.
-
getProcedure
- Returns:
procedure
(Type of procedure performed.)
-
hasProcedure
-
addProcedure
- Returns:
procedure
(Type of procedure performed.)
-
addProcedure
-
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
- 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
- Returns:
interpreter
(Who read the study and interpreted the images or other content.)
-
hasInterpreter
-
setInterpreter
- Parameters:
value
-interpreter
(Who read the study and interpreted the images or other content.)
-
getInterpreterTarget
- Returns:
interpreter
The 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
- Parameters:
value
-interpreter
The 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
- 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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- Institution-generated description or classification of the Study performed.
-
setDescription
- Parameters:
value
- Institution-generated description or classification of the Study performed.
-
getSeries
- Returns:
series
(Each study has one or more series of images or other content.)
-
hasSeries
-
addSeries
- Returns:
series
(Each study has one or more series of images or other content.)
-
addSeries
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-