Class DeviceRequest

  • 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 DeviceRequest
    extends DomainResource
    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.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Identifiers assigned to this order by the orderer or by the receiver.
      • definition

        protected List<Reference> definition
        Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
      • definitionTarget

        protected List<Resource> definitionTarget
        The actual objects that are the target of the reference (Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.)
      • basedOnTarget

        protected List<Resource> basedOnTarget
        The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)
      • priorRequest

        protected List<Reference> priorRequest
        The request takes the place of the referenced completed or terminated request(s).
      • priorRequestTarget

        protected List<Resource> priorRequestTarget
        The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)
      • intent

        protected CodeableConcept intent
        Whether the request is a proposal, plan, an original order or a reflex order.
      • code

        protected Type code
        The details of the device to be used.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (The patient who will use the device.)
      • context

        protected Reference context
        An encounter that provides additional context in which this request is made.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.)
      • occurrence

        protected Type occurrence
        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".
      • performer

        protected Reference performer
        The desired perfomer for doing the diagnostic testing.
      • performerTarget

        protected Resource performerTarget
        The actual object that is the target of the reference (The desired perfomer for doing the diagnostic testing.)
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Reason or justification for the use of this device.)
      • supportingInfo

        protected List<Reference> supportingInfo
        Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).
      • supportingInfoTarget

        protected List<Resource> supportingInfoTarget
        The actual objects that are the target of the reference (Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).)
      • note

        protected List<Annotation> note
        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.
      • SP_REQUESTER

        public static final String SP_REQUESTER
        Search parameter: requester

        Description: Who/what is requesting service 
        Type: reference
        Path: DeviceRequest.requester.agent

        See Also:
        Constant Field Values
      • REQUESTER

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

        Description: Who/what is requesting service 
        Type: reference
        Path: DeviceRequest.requester.agent

      • INCLUDE_REQUESTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:requester".
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Business identifier for request/order
        Type: token
        Path: DeviceRequest.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Business identifier for request/order
        Type: token
        Path: DeviceRequest.identifier

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Code for what is being requested/ordered
        Type: token
        Path: DeviceRequest.codeCodeableConcept

        See Also:
        Constant Field Values
      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: Code for what is being requested/ordered
        Type: token
        Path: DeviceRequest.codeCodeableConcept

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: performer

        Description: Desired performer for service
        Type: reference
        Path: DeviceRequest.performer

        See Also:
        Constant Field Values
      • PERFORMER

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

        Description: Desired performer for service
        Type: reference
        Path: DeviceRequest.performer

      • INCLUDE_PERFORMER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:performer".
      • SP_EVENT_DATE

        public static final String SP_EVENT_DATE
        Search parameter: event-date

        Description: When service should occur
        Type: date
        Path: DeviceRequest.occurrenceDateTime, DeviceRequest.occurrencePeriod

        See Also:
        Constant Field Values
      • EVENT_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EVENT_DATE
        Fluent Client search parameter constant for event-date

        Description: When service should occur
        Type: date
        Path: DeviceRequest.occurrenceDateTime, DeviceRequest.occurrencePeriod

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Individual the service is ordered for
        Type: reference
        Path: DeviceRequest.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: Individual the service is ordered for
        Type: reference
        Path: DeviceRequest.subject

      • 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 "DeviceRequest:subject".
      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: Encounter or Episode during which request was created
        Type: reference
        Path: DeviceRequest.context

        See Also:
        Constant Field Values
      • ENCOUNTER

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

        Description: Encounter or Episode during which request was created
        Type: reference
        Path: DeviceRequest.context

      • INCLUDE_ENCOUNTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:encounter".
      • SP_AUTHORED_ON

        public static final String SP_AUTHORED_ON
        Search parameter: authored-on

        Description: When the request transitioned to being actionable
        Type: date
        Path: DeviceRequest.authoredOn

        See Also:
        Constant Field Values
      • AUTHORED_ON

        public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED_ON
        Fluent Client search parameter constant for authored-on

        Description: When the request transitioned to being actionable
        Type: date
        Path: DeviceRequest.authoredOn

      • SP_INTENT

        public static final String SP_INTENT
        Search parameter: intent

        Description: proposal | plan | original-order |reflex-order
        Type: token
        Path: DeviceRequest.intent

        See Also:
        Constant Field Values
      • INTENT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
        Fluent Client search parameter constant for intent

        Description: proposal | plan | original-order |reflex-order
        Type: token
        Path: DeviceRequest.intent

      • SP_GROUP_IDENTIFIER

        public static final String SP_GROUP_IDENTIFIER
        Search parameter: group-identifier

        Description: Composite request this is part of
        Type: token
        Path: DeviceRequest.groupIdentifier

        See Also:
        Constant Field Values
      • GROUP_IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP_IDENTIFIER
        Fluent Client search parameter constant for group-identifier

        Description: Composite request this is part of
        Type: token
        Path: DeviceRequest.groupIdentifier

      • SP_BASED_ON

        public static final String SP_BASED_ON
        Search parameter: based-on

        Description: Plan/proposal/order fulfilled by this request
        Type: reference
        Path: DeviceRequest.basedOn

        See Also:
        Constant Field Values
      • BASED_ON

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
        Fluent Client search parameter constant for based-on

        Description: Plan/proposal/order fulfilled by this request
        Type: reference
        Path: DeviceRequest.basedOn

      • INCLUDE_BASED_ON

        public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:based-on".
      • SP_PRIORREQUEST

        public static final String SP_PRIORREQUEST
        Search parameter: priorrequest

        Description: Request takes the place of referenced completed or terminated requests
        Type: reference
        Path: DeviceRequest.priorRequest

        See Also:
        Constant Field Values
      • PRIORREQUEST

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

        Description: Request takes the place of referenced completed or terminated requests
        Type: reference
        Path: DeviceRequest.priorRequest

      • INCLUDE_PRIORREQUEST

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PRIORREQUEST
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:priorrequest".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Individual the service is ordered for
        Type: reference
        Path: DeviceRequest.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: Individual the service is ordered for
        Type: reference
        Path: DeviceRequest.subject

      • 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 "DeviceRequest:patient".
      • SP_DEFINITION

        public static final String SP_DEFINITION
        Search parameter: definition

        Description: Protocol or definition followed by this request
        Type: reference
        Path: DeviceRequest.definition

        See Also:
        Constant Field Values
      • DEFINITION

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

        Description: Protocol or definition followed by this request
        Type: reference
        Path: DeviceRequest.definition

      • INCLUDE_DEFINITION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:definition".
      • SP_DEVICE

        public static final String SP_DEVICE
        Search parameter: device

        Description: Reference to resource that is being requested/ordered
        Type: reference
        Path: DeviceRequest.codeReference

        See Also:
        Constant Field Values
      • DEVICE

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

        Description: Reference to resource that is being requested/ordered
        Type: reference
        Path: DeviceRequest.codeReference

      • 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 "DeviceRequest:device".
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: entered-in-error | draft | active |suspended | completed 
        Type: token
        Path: DeviceRequest.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: entered-in-error | draft | active |suspended | completed 
        Type: token
        Path: DeviceRequest.status