Class ImagingObjectSelection
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.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 Description static classImagingObjectSelection.FramesComponentstatic classImagingObjectSelection.InstanceComponentstatic classImagingObjectSelection.SeriesComponentstatic classImagingObjectSelection.StudyComponent
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceauthorAuthor of ImagingObjectSelection.static ca.uhn.fhir.rest.gclient.ReferenceClientParamAUTHORFluent Client search parameter constant for authorstatic ca.uhn.fhir.rest.gclient.DateClientParamAUTHORING_TIMEFluent Client search parameter constant for authoring-timeprotected DateTimeTypeauthoringTimeDate and time when the selection of the referenced instances were made.protected ResourceauthorTargetThe actual object that is the target of the reference (Author of ImagingObjectSelection.protected StringTypedescriptionText description of the DICOM SOP instances selected in the ImagingObjectSelection.static ca.uhn.fhir.rest.gclient.UriClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_AUTHORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.protected ReferencepatientA patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe 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 ca.uhn.fhir.rest.gclient.UriClientParamSELECTED_STUDYFluent Client search parameter constant for selected-studystatic StringSP_AUTHORSearch parameter: authorstatic StringSP_AUTHORING_TIMESearch parameter: authoring-timestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SELECTED_STUDYSearch parameter: selected-studystatic StringSP_TITLESearch parameter: titleprotected List<ImagingObjectSelection.StudyComponent>studyStudy identity and locating information of the DICOM SOP instances in the selection.protected CodeableConcepttitleThe reason for, or significance of, the selection of objects referenced in the resource.static ca.uhn.fhir.rest.gclient.TokenClientParamTITLEFluent Client search parameter constant for titleprotected OidTypeuidInstance UID of the DICOM KOS SOP Instances represented in this resource.-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImagingObjectSelection()ConstructorImagingObjectSelection(OidType uid, Reference patient, CodeableConcept title)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, 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
-
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.)
-
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).
-
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.)
-
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.
-
study
protected List<ImagingObjectSelection.StudyComponent> study
Study identity and locating information of the DICOM SOP instances in the selection.
-
SP_SELECTED_STUDY
public static final String SP_SELECTED_STUDY
Search parameter: selected-studyDescription: Study selected in key DICOM object selection
Type: uri
Path: ImagingObjectSelection.study.uid
- See Also:
- Constant Field Values
-
SELECTED_STUDY
public static final ca.uhn.fhir.rest.gclient.UriClientParam SELECTED_STUDY
Fluent Client search parameter constant for selected-studyDescription: Study selected in key DICOM object selection
Type: uri
Path: ImagingObjectSelection.study.uid
-
SP_AUTHOR
public static final String SP_AUTHOR
Search parameter: authorDescription: Author of key DICOM object selection
Type: reference
Path: ImagingObjectSelection.author
- See Also:
- Constant Field Values
-
AUTHOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
Fluent Client search parameter constant for authorDescription: Author of key DICOM object selection
Type: reference
Path: ImagingObjectSelection.author
-
INCLUDE_AUTHOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingObjectSelection:author".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Title of key DICOM object selection
Type: token
Path: ImagingObjectSelection.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TITLE
Fluent Client search parameter constant for titleDescription: Title of key DICOM object selection
Type: token
Path: ImagingObjectSelection.title
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Subject of key DICOM object selection
Type: reference
Path: ImagingObjectSelection.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Subject of key DICOM object selection
Type: reference
Path: ImagingObjectSelection.patient
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingObjectSelection:patient".
-
SP_AUTHORING_TIME
public static final String SP_AUTHORING_TIME
Search parameter: authoring-timeDescription: Time of key DICOM object selection authoring
Type: date
Path: ImagingObjectSelection.authoringTime
- See Also:
- Constant Field Values
-
AUTHORING_TIME
public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORING_TIME
Fluent Client search parameter constant for authoring-timeDescription: Time of key DICOM object selection authoring
Type: date
Path: ImagingObjectSelection.authoringTime
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: UID of key DICOM object selection
Type: uri
Path: ImagingObjectSelection.uid
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.UriClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: UID of key DICOM object selection
Type: uri
Path: ImagingObjectSelection.uid
-
-
Constructor Detail
-
ImagingObjectSelection
public ImagingObjectSelection()
Constructor
-
ImagingObjectSelection
public ImagingObjectSelection(OidType uid, Reference patient, CodeableConcept title)
Constructor
-
-
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:
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. (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-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. (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.)
-
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).
-
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:
authorThe 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-authorThe 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.)
-
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.
-
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:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- 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 ImagingObjectSelection copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected ImagingObjectSelection 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
-
-