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

        public static final String SP_SELECTED_STUDY
        Search parameter: 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 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

      • SP_AUTHOR

        public static final String SP_AUTHOR
        Search parameter: author

        Description: 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 author

        Description: 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: title

        Description: 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 title

        Description: Title of key DICOM object selection
        Type: token
        Path: ImagingObjectSelection.title

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: 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 patient

        Description: 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-time

        Description: 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-time

        Description: Time of key DICOM object selection authoring
        Type: date
        Path: ImagingObjectSelection.authoringTime

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: 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 identifier

        Description: UID of key DICOM object selection
        Type: uri
        Path: ImagingObjectSelection.uid

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

        public Reference getPatient()
        Returns:
        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.)
      • 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
      • 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.)
      • 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.)
      • getTitle

        public CodeableConcept getTitle()
        Returns:
        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
      • 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.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make 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:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

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