Class DeviceUseRequest

  • 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 DeviceUseRequest
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR DeviceUseRequest Resource (workflow.order)

    Definition: Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

    Requirements:

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

    See Also:
    Serialized Form
    • Field Detail

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter constant for subject

        Description: Search by subject
        Type: reference
        Path: DeviceUseRequest.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: Search by subject
        Type: reference
        Path: DeviceUseRequest.subject

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: Search by subject - a patient
        Type: reference
        Path: DeviceUseRequest.subject

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Search by subject - a patient
        Type: reference
        Path: DeviceUseRequest.subject

      • DEVICE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
        Fluent Client search parameter constant for device

        Description:
        Type: reference
        Path: DeviceUseRequest.device

      • INCLUDE_DEVICE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseRequest:device".
      • 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 "DeviceUseRequest:patient".
      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseRequest:subject".
    • Method Detail

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

        public ca.uhn.fhir.model.api.IDatatype getBodySite()
        Gets the value(s) for bodySite[x] (). creating it if it does not exist. Will not return null.

        Definition: Indicates the site on the subject's body where the device should be used ( i.e. the target site).

      • setBodySite

        public DeviceUseRequest setBodySite​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for bodySite[x] ()

        Definition: Indicates the site on the subject's body where the device should be used ( i.e. the target site).

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceUseRequestStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The status of the request.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The status of the request.

      • getDevice

        public ResourceReferenceDt getDevice()
        Gets the value(s) for device (). creating it if it does not exist. Will not return null.

        Definition: The details of the device to be used.

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

        Definition: An encounter that provides additional context in which this request is made.

      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Identifiers assigned to this order by the orderer or by the receiver.

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Identifiers assigned to this order by the orderer or by the receiver.

      • addIdentifier

        public DeviceUseRequest addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Identifiers assigned to this order by the orderer or by the receiver.

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Identifiers assigned to this order by the orderer or by the receiver.

      • getIndication

        public List<CodeableConceptDtgetIndication()
        Gets the value(s) for indication (why). creating it if it does not exist. Will not return null.

        Definition: Reason or justification for the use of this device.

      • addIndication

        public CodeableConceptDt addIndication()
        Adds and returns a new value for indication (why)

        Definition: Reason or justification for the use of this device.

      • addIndication

        public DeviceUseRequest addIndication​(CodeableConceptDt theValue)
        Adds a given new value for indication (why)

        Definition: Reason or justification for the use of this device.

        Parameters:
        theValue - The indication to add (must not be null)
      • getIndicationFirstRep

        public CodeableConceptDt getIndicationFirstRep()
        Gets the first repetition for indication (why), creating it if it does not already exist.

        Definition: Reason or justification for the use of this device.

      • getNotes

        public List<ca.uhn.fhir.model.primitive.StringDt> getNotes()
        Gets the value(s) for notes (). creating it if it does not exist. Will not return null.

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

      • setNotes

        public DeviceUseRequest setNotes​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for notes ()

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

      • addNotes

        public ca.uhn.fhir.model.primitive.StringDt addNotes()
        Adds and returns a new value for notes ()

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

      • addNotes

        public DeviceUseRequest addNotes​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for notes ()

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

        Parameters:
        theValue - The notes to add (must not be null)
      • getNotesFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getNotesFirstRep()
        Gets the first repetition for notes (), creating it if it does not already exist.

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

      • addNotes

        public DeviceUseRequest addNotes​(String theString)
        Adds a new value for notes ()

        Definition: Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getPrnReason

        public List<CodeableConceptDtgetPrnReason()
        Gets the value(s) for prnReason (). creating it if it does not exist. Will not return null.

        Definition: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

      • setPrnReason

        public DeviceUseRequest setPrnReason​(List<CodeableConceptDt> theValue)
        Sets the value(s) for prnReason ()

        Definition: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

      • addPrnReason

        public CodeableConceptDt addPrnReason()
        Adds and returns a new value for prnReason ()

        Definition: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

      • addPrnReason

        public DeviceUseRequest addPrnReason​(CodeableConceptDt theValue)
        Adds a given new value for prnReason ()

        Definition: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

        Parameters:
        theValue - The prnReason to add (must not be null)
      • getPrnReasonFirstRep

        public CodeableConceptDt getPrnReasonFirstRep()
        Gets the first repetition for prnReason (), creating it if it does not already exist.

        Definition: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

      • getOrderedOnElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getOrderedOnElement()
        Gets the value(s) for orderedOn (when.init). creating it if it does not exist. Will not return null.

        Definition: The time when the request was made.

      • getOrderedOn

        public Date getOrderedOn()
        Gets the value(s) for orderedOn (when.init). creating it if it does not exist. This method may return null.

        Definition: The time when the request was made.

      • setOrderedOn

        public DeviceUseRequest setOrderedOn​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for orderedOn (when.init)

        Definition: The time when the request was made.

      • setOrderedOn

        public DeviceUseRequest setOrderedOn​(Date theDate,
                                             ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for orderedOn (when.init)

        Definition: The time when the request was made.

      • getRecordedOnElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getRecordedOnElement()
        Gets the value(s) for recordedOn (when.recorded). creating it if it does not exist. Will not return null.

        Definition: The time at which the request was made/recorded.

      • getRecordedOn

        public Date getRecordedOn()
        Gets the value(s) for recordedOn (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The time at which the request was made/recorded.

      • setRecordedOn

        public DeviceUseRequest setRecordedOn​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for recordedOn (when.recorded)

        Definition: The time at which the request was made/recorded.

      • setRecordedOn

        public DeviceUseRequest setRecordedOn​(Date theDate,
                                              ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for recordedOn (when.recorded)

        Definition: The time at which the request was made/recorded.

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

        Definition: The patient who will use the device.

      • getTiming

        public ca.uhn.fhir.model.api.IDatatype getTiming()
        Gets the value(s) for timing[x] (when.planned). creating it if it does not exist. Will not return null.

        Definition: The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".

      • setTiming

        public DeviceUseRequest setTiming​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for timing[x] (when.planned)

        Definition: The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".

      • getPriorityElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceUseRequestPriorityEnumgetPriorityElement()
        Gets the value(s) for priority (grade). creating it if it does not exist. Will not return null.

        Definition: Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

      • getPriority

        public String getPriority()
        Gets the value(s) for priority (grade). creating it if it does not exist. This method may return null.

        Definition: Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

      • setPriority

        public DeviceUseRequest setPriority​(ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceUseRequestPriorityEnum> theValue)
        Sets the value(s) for priority (grade)

        Definition: Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

      • 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