Package ca.uhn.fhir.model.dstu2.resource

Class ImagingObjectSelection

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:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
public class ImagingObjectSelection extends BaseResource implements ca.uhn.fhir.model.api.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:

  • Field Details

    • 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:

    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.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:

    • TITLE

      public static final ca.uhn.fhir.rest.gclient.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:

    • AUTHOR

      public static final ca.uhn.fhir.rest.gclient.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:

    • AUTHORING_TIME

      public static final ca.uhn.fhir.rest.gclient.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:

    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.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:

    • SELECTED_STUDY

      public static final ca.uhn.fhir.rest.gclient.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 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".

    • 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".

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getUidElement

      public ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: Instance UID of the DICOM KOS SOP Instances represented in this resource.

    • setUid

      public ImagingObjectSelection setUid(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may 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(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may 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(ca.uhn.fhir.model.primitive.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).

    • 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).

    • setAuthoringTime

      public ImagingObjectSelection setAuthoringTime(Date theDate, ca.uhn.fhir.model.api.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).

    • 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 ca.uhn.fhir.model.api.IResource

    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource