ImagingObjectSelection (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.ImagingObjectSelection

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class ImagingObjectSelection
extends BaseResource
implements IResource
```
HAPI/FHIR ImagingObjectSelection Resource (clinical.diagnostics)
Definition: A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingObjectSelection resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance (\"cine\" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on.

Requirements: A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.

Profile Definition: http://hl7.org/fhir/profiles/ImagingObjectSelection

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImagingObjectSelection.Study` Block class for child element: ImagingObjectSelection.study ()
`static class`	`ImagingObjectSelection.StudySeries` Block class for child element: ImagingObjectSelection.study.series ()
`static class`	`ImagingObjectSelection.StudySeriesInstance` Block class for child element: ImagingObjectSelection.study.series.instance ()
`static class`	`ImagingObjectSelection.StudySeriesInstanceFrames` Block class for child element: ImagingObjectSelection.study.series.instance.frames ()

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`static DateClientParam`	`AUTHORING_TIME` Fluent Client search parameter constant for authoring-time
`static UriClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_AUTHOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static UriClientParam`	`SELECTED_STUDY` Fluent Client search parameter constant for selected-study
`static String`	`SP_AUTHOR` Search parameter constant for author
`static String`	`SP_AUTHORING_TIME` Search parameter constant for authoring-time
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SELECTED_STUDY` Search parameter constant for selected-study
`static String`	`SP_TITLE` Search parameter constant for title
`static TokenClientParam`	`TITLE` Fluent Client search parameter constant for title

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

ImagingObjectSelection()

Constructors
Constructor and Description
`ImagingObjectSelection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImagingObjectSelection.Study`	`addStudy()` Adds and returns a new value for study ()
`ImagingObjectSelection`	`addStudy(ImagingObjectSelection.Study theValue)` Adds a given new value for study ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAuthor()` Gets the value(s) for author (who.author).
`Date`	`getAuthoringTime()` Gets the value(s) for authoringTime (when.recorded).
`DateTimeDt`	`getAuthoringTimeElement()` Gets the value(s) for authoringTime (when.recorded).
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (who.focus).
`String`	`getResourceName()`
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<ImagingObjectSelection.Study>`	`getStudy()` Gets the value(s) for study ().
`ImagingObjectSelection.Study`	`getStudyFirstRep()` Gets the first repetition for study (), creating it if it does not already exist.
`BoundCodeableConceptDt<KOStitleEnum>`	`getTitle()` Gets the value(s) for title ().
`String`	`getUid()` Gets the value(s) for uid (id).
`OidDt`	`getUidElement()` Gets the value(s) for uid (id).
`boolean`	`isEmpty()`
`ImagingObjectSelection`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author (who.author)
`ImagingObjectSelection`	`setAuthoringTime(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for authoringTime (when.recorded)
`ImagingObjectSelection`	`setAuthoringTime(DateTimeDt theValue)` Sets the value(s) for authoringTime (when.recorded)
`ImagingObjectSelection`	`setAuthoringTimeWithSecondsPrecision(Date theDate)` Sets the value for authoringTime (when.recorded)
`ImagingObjectSelection`	`setDescription(String theString)` Sets the value for description ()
`ImagingObjectSelection`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`ImagingObjectSelection`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (who.focus)
`ImagingObjectSelection`	`setStudy(List<ImagingObjectSelection.Study> theValue)` Sets the value(s) for study ()
`ImagingObjectSelection`	`setTitle(BoundCodeableConceptDt<KOStitleEnum> theValue)` Sets the value(s) for title ()
`ImagingObjectSelection`	`setTitle(KOStitleEnum theValue)` Sets the value(s) for title ()
`ImagingObjectSelection`	`setUid(OidDt theValue)` Sets the value(s) for uid (id)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: UID of key DICOM object selection
    Type: uri
    Path: ImagingObjectSelection.uid
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final UriClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: UID of key DICOM object selection
    Type: uri
    Path: ImagingObjectSelection.uid
  - SP_TITLE
```
public static final String SP_TITLE
```
    Search parameter constant for title
    Description: Title of key DICOM object selection
    Type: token
    Path: ImagingObjectSelection.title
    
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final TokenClientParam TITLE
```
    Fluent Client search parameter constant for title
    Description: Title of key DICOM object selection
    Type: token
    Path: ImagingObjectSelection.title
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description: Author of key DICOM object selection
    Type: reference
    Path: ImagingObjectSelection.author
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
public static final ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description: Author of key DICOM object selection
    Type: reference
    Path: ImagingObjectSelection.author
  - SP_AUTHORING_TIME
```
public static final String SP_AUTHORING_TIME
```
    Search parameter constant for authoring-time
    Description: Time of key DICOM object selection authoring
    Type: date
    Path: ImagingObjectSelection.authoringTime
    
    See Also:
    
    Constant Field Values
  - AUTHORING_TIME
```
public static final DateClientParam AUTHORING_TIME
```
    Fluent Client search parameter constant for authoring-time
    Description: Time of key DICOM object selection authoring
    Type: date
    Path: ImagingObjectSelection.authoringTime
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: Subject of key DICOM object selection
    Type: reference
    Path: ImagingObjectSelection.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Subject of key DICOM object selection
    Type: reference
    Path: ImagingObjectSelection.patient
  - SP_SELECTED_STUDY
```
public static final String SP_SELECTED_STUDY
```
    Search parameter constant for selected-study
    Description: Study selected in key DICOM object selection
    Type: uri
    Path: ImagingObjectSelection.study.uid
    
    See Also:
    
    Constant Field Values
  - SELECTED_STUDY
```
public static final UriClientParam SELECTED_STUDY
```
    Fluent Client search parameter constant for selected-study
    Description: Study selected in key DICOM object selection
    Type: uri
    Path: ImagingObjectSelection.study.uid
  - INCLUDE_AUTHOR
```
public static final Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingObjectSelection:author".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingObjectSelection:patient".
- Constructor Detail
  - ImagingObjectSelection
```
public ImagingObjectSelection()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getUidElement
```
public OidDt getUidElement()
```
    Gets the value(s) for uid (id). creating it if it does not exist. Will not return null.
    Definition: Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - getUid
```
public String getUid()
```
    Gets the value(s) for uid (id). creating it if it does not exist. Will not return null.
    Definition: Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - setUid
```
public ImagingObjectSelection setUid(OidDt theValue)
```
    Sets the value(s) for uid (id)
    Definition: Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.
    Definition: A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.
  - setPatient
```
public ImagingObjectSelection setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (who.focus)
    Definition: A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.
  - getTitle
```
public BoundCodeableConceptDt<KOStitleEnum> getTitle()
```
    Gets the value(s) for title (). creating it if it does not exist. Will not return null.
    Definition: The reason for, or significance of, the selection of objects referenced in the resource
  - setTitle
```
public ImagingObjectSelection setTitle(BoundCodeableConceptDt<KOStitleEnum> theValue)
```
    Sets the value(s) for title ()
    Definition: The reason for, or significance of, the selection of objects referenced in the resource
  - setTitle
```
public ImagingObjectSelection setTitle(KOStitleEnum theValue)
```
    Sets the value(s) for title ()
    Definition: The reason for, or significance of, the selection of objects referenced in the resource
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.
  - getDescription
```
public String getDescription()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.
  - setDescription
```
public ImagingObjectSelection setDescription(StringDt theValue)
```
    Sets the value(s) for description ()
    Definition: Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.
  - setDescription
```
public ImagingObjectSelection setDescription(String theString)
```
    Sets the value for description ()
    Definition: Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.
  - getAuthor
```
public ResourceReferenceDt getAuthor()
```
    Gets the value(s) for author (who.author). creating it if it does not exist. Will not return null.
    Definition: Author of ImagingObjectSelection. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
  - setAuthor
```
public ImagingObjectSelection setAuthor(ResourceReferenceDt theValue)
```
    Sets the value(s) for author (who.author)
    Definition: Author of ImagingObjectSelection. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
  - getAuthoringTimeElement
```
public DateTimeDt getAuthoringTimeElement()
```
    Gets the value(s) for authoringTime (when.recorded). creating it if it does not exist. Will not return null.
    Definition: Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
  - getAuthoringTime
```
public Date getAuthoringTime()
```
    Gets the value(s) for authoringTime (when.recorded). creating it if it does not exist. Will not return null.
    Definition: Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
  - setAuthoringTime
```
public ImagingObjectSelection setAuthoringTime(DateTimeDt theValue)
```
    Sets the value(s) for authoringTime (when.recorded)
    Definition: Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
  - setAuthoringTime
```
public ImagingObjectSelection setAuthoringTime(Date theDate,
                                               TemporalPrecisionEnum thePrecision)
```
    Sets the value for authoringTime (when.recorded)
    Definition: Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
  - setAuthoringTimeWithSecondsPrecision
```
public ImagingObjectSelection setAuthoringTimeWithSecondsPrecision(Date theDate)
```
    Sets the value for authoringTime (when.recorded)
    Definition: Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
  - getStudy
```
public List<ImagingObjectSelection.Study> getStudy()
```
    Gets the value(s) for study (). creating it if it does not exist. Will not return null.
    Definition: Study identity and locating information of the DICOM SOP instances in the selection.
  - setStudy
```
public ImagingObjectSelection setStudy(List<ImagingObjectSelection.Study> theValue)
```
    Sets the value(s) for study ()
    Definition: Study identity and locating information of the DICOM SOP instances in the selection.
  - addStudy
```
public ImagingObjectSelection.Study addStudy()
```
    Adds and returns a new value for study ()
    Definition: Study identity and locating information of the DICOM SOP instances in the selection.
  - addStudy
```
public ImagingObjectSelection addStudy(ImagingObjectSelection.Study theValue)
```
    Adds a given new value for study ()
    Definition: Study identity and locating information of the DICOM SOP instances in the selection.
    
    Parameters:
    
    theValue - The study to add (must not be null)
  - getStudyFirstRep
```
public ImagingObjectSelection.Study getStudyFirstRep()
```
    Gets the first repetition for study (), creating it if it does not already exist.
    Definition: Study identity and locating information of the DICOM SOP instances in the selection.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class ImagingObjectSelection

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_TITLE

TITLE

SP_AUTHOR

AUTHOR

SP_AUTHORING_TIME

AUTHORING_TIME

SP_PATIENT

PATIENT

SP_SELECTED_STUDY

SELECTED_STUDY

INCLUDE_AUTHOR

INCLUDE_PATIENT

Constructor Detail

ImagingObjectSelection

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getUidElement

getUid

setUid

getPatient

setPatient

getTitle

setTitle

setTitle

getDescriptionElement

getDescription

setDescription

setDescription

getAuthor

setAuthor

getAuthoringTimeElement

getAuthoringTime

setAuthoringTime

setAuthoringTime

setAuthoringTimeWithSecondsPrecision

getStudy

setStudy

addStudy

addStudy

getStudyFirstRep

getResourceName

getStructureFhirVersionEnum