ImagingObjectSelection (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.ImagingObjectSelection

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 ImagingObjectSelection
extends DomainResource
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImagingObjectSelection.FramesComponent`
`static class`	`ImagingObjectSelection.InstanceComponent`
`static class`	`ImagingObjectSelection.SeriesComponent`
`static class`	`ImagingObjectSelection.StudyComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`author` Author of ImagingObjectSelection.
`protected DateTimeType`	`authoringTime` Date and time when the selection of the referenced instances were made.
`protected Resource`	`authorTarget` The actual object that is the target of the reference (Author of ImagingObjectSelection.
`protected StringType`	`description` Text description of the DICOM SOP instances selected in the ImagingObjectSelection.
`protected Reference`	`patient` A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.
`protected Patient`	`patientTarget` The actual object that is the target of the reference (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
`static String`	`SP_AUTHOR`
`static String`	`SP_AUTHORINGTIME`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_SELECTEDSTUDY`
`static String`	`SP_TITLE`
`protected List<ImagingObjectSelection.StudyComponent>`	`study` Study identity and locating information of the DICOM SOP instances in the selection.
`protected CodeableConcept`	`title` The reason for, or significance of, the selection of objects referenced in the resource.
`protected OidType`	`uid` Instance UID of the DICOM KOS SOP Instances represented in this resource.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
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()`
`ImagingObjectSelection(OidType uid, Reference patient, CodeableConcept title)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ImagingObjectSelection.StudyComponent`	`addStudy()`
`ImagingObjectSelection`	`addStudy(ImagingObjectSelection.StudyComponent t)`
`ImagingObjectSelection`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getAuthor()`
`Date`	`getAuthoringTime()`
`DateTimeType`	`getAuthoringTimeElement()`
`Resource`	`getAuthorTarget()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`ResourceType`	`getResourceType()`
`List<ImagingObjectSelection.StudyComponent>`	`getStudy()`
`CodeableConcept`	`getTitle()`
`String`	`getUid()`
`OidType`	`getUidElement()`
`boolean`	`hasAuthor()`
`boolean`	`hasAuthoringTime()`
`boolean`	`hasAuthoringTimeElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasPatient()`
`boolean`	`hasStudy()`
`boolean`	`hasTitle()`
`boolean`	`hasUid()`
`boolean`	`hasUidElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`ImagingObjectSelection`	`setAuthor(Reference value)`
`ImagingObjectSelection`	`setAuthoringTime(Date value)`
`ImagingObjectSelection`	`setAuthoringTimeElement(DateTimeType value)`
`ImagingObjectSelection`	`setAuthorTarget(Resource value)`
`ImagingObjectSelection`	`setDescription(String value)`
`ImagingObjectSelection`	`setDescriptionElement(StringType value)`
`ImagingObjectSelection`	`setPatient(Reference value)`
`ImagingObjectSelection`	`setPatientTarget(Patient value)`
`void`	`setProperty(String name, Base value)`
`ImagingObjectSelection`	`setTitle(CodeableConcept value)`
`ImagingObjectSelection`	`setUid(String value)`
`ImagingObjectSelection`	`setUidElement(OidType value)`
`protected ImagingObjectSelection`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - uid
```
protected OidType uid
```
    Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - patient
```
protected Reference patient
```
    A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
  - title
```
protected CodeableConcept title
```
    The reason for, or significance of, the selection of objects referenced in the resource.
  - description
```
protected StringType description
```
    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.
  - author
```
protected Reference author
```
    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.
  - authorTarget
```
protected Resource authorTarget
```
    The actual object that is the target of the reference (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.)
  - authoringTime
```
protected DateTimeType authoringTime
```
    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).
  - study
```
protected List<ImagingObjectSelection.StudyComponent> study
```
    Study identity and locating information of the DICOM SOP instances in the selection.
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_AUTHORINGTIME
```
public static final String SP_AUTHORINGTIME
```
    See Also:
    
    Constant Field Values
  - SP_SELECTEDSTUDY
```
public static final String SP_SELECTEDSTUDY
```
    See Also:
    
    Constant Field Values
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_TITLE
```
public static final String SP_TITLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImagingObjectSelection
```
public ImagingObjectSelection()
```
  - ImagingObjectSelection
```
public ImagingObjectSelection(OidType uid,
                              Reference patient,
                              CodeableConcept title)
```
- Method Detail
  - getUidElement
```
public OidType getUidElement()
```
    Returns:
    
    uid (Instance UID of the DICOM KOS SOP Instances represented in this resource.). 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 ImagingObjectSelection setUidElement(OidType value)
```
    Parameters:
    
    value - uid (Instance UID of the DICOM KOS SOP Instances represented in this resource.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
  - getUid
```
public String getUid()
```
    Returns:
    
    Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - setUid
```
public ImagingObjectSelection setUid(String value)
```
    Parameters:
    
    value - Instance UID of the DICOM KOS SOP Instances represented in this resource.
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public ImagingObjectSelection setPatient(Reference value)
```
    Parameters:
    
    value - patient (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
  - getPatientTarget
```
public Patient 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. (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
  - setPatientTarget
```
public ImagingObjectSelection setPatientTarget(Patient value)
```
    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. (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
  - getTitle
```
public CodeableConcept getTitle()
```
    Returns:
    
    title (The reason for, or significance of, the selection of objects referenced in the resource.)
  - hasTitle
```
public boolean hasTitle()
```
  - setTitle
```
public ImagingObjectSelection setTitle(CodeableConcept value)
```
    Parameters:
    
    value - title (The reason for, or significance of, the selection of objects referenced in the resource.)
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (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.). 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 ImagingObjectSelection setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    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 value)
```
    Parameters:
    
    value - 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 Reference getAuthor()
```
    Returns:
    
    author (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.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - setAuthor
```
public ImagingObjectSelection setAuthor(Reference value)
```
    Parameters:
    
    value - author (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.)
  - getAuthorTarget
```
public Resource getAuthorTarget()
```
    Returns:
    
    author 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. (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.)
  - setAuthorTarget
```
public ImagingObjectSelection setAuthorTarget(Resource value)
```
    Parameters:
    
    value - author 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. (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 DateTimeType getAuthoringTimeElement()
```
    Returns:
    
    authoringTime (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).). This is the underlying object with id, value and extensions. The accessor "getAuthoringTime" gives direct access to the value
  - hasAuthoringTimeElement
```
public boolean hasAuthoringTimeElement()
```
  - hasAuthoringTime
```
public boolean hasAuthoringTime()
```
  - setAuthoringTimeElement
```
public ImagingObjectSelection setAuthoringTimeElement(DateTimeType value)
```
    Parameters:
    
    value - authoringTime (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).). This is the underlying object with id, value and extensions. The accessor "getAuthoringTime" gives direct access to the value
  - getAuthoringTime
```
public Date getAuthoringTime()
```
    Returns:
    
    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 value)
```
    Parameters:
    
    value - 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.StudyComponent> getStudy()
```
    Returns:
    
    study (Study identity and locating information of the DICOM SOP instances in the selection.)
  - hasStudy
```
public boolean hasStudy()
```
  - addStudy
```
public ImagingObjectSelection.StudyComponent addStudy()
```
    Returns:
    
    study (Study identity and locating information of the DICOM SOP instances in the selection.)
  - addStudy
```
public ImagingObjectSelection addStudy(ImagingObjectSelection.StudyComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public ImagingObjectSelection copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected ImagingObjectSelection typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class ImagingObjectSelection

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.instance.model.DomainResource

Fields inherited from class org.hl7.fhir.instance.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

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

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

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

Field Detail

uid

patient

patientTarget

title

description

author

authorTarget

authoringTime

study

SP_IDENTIFIER

SP_AUTHORINGTIME

SP_SELECTEDSTUDY

SP_AUTHOR

SP_PATIENT

SP_TITLE

Constructor Detail

ImagingObjectSelection

ImagingObjectSelection

Method Detail

getUidElement

hasUidElement

hasUid

setUidElement

getUid

setUid

getPatient

hasPatient

setPatient

getPatientTarget

setPatientTarget

getTitle

hasTitle

setTitle

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getAuthor

hasAuthor

setAuthor

getAuthorTarget

setAuthorTarget

getAuthoringTimeElement

hasAuthoringTimeElement

hasAuthoringTime

setAuthoringTimeElement

getAuthoringTime

setAuthoringTime

getStudy

hasStudy

addStudy

addStudy

listChildren

setProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow