Package org.hl7.fhir.r4.model

Class DeviceRequest

java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.model.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:

  • Field Details

    • identifier

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

    • instantiatesCanonical

      protected List<CanonicalType> instantiatesCanonical
      The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

    • instantiatesUri

      protected List<UriType> instantiatesUri
      The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

    • basedOn

      protected List<Reference> basedOn
      Plan/proposal/order fulfilled by this request.

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

    • groupIdentifier

      protected Identifier groupIdentifier
      Composite request this is part of.

    • status

      protected Enumeration<DeviceRequest.DeviceRequestStatus> status
      The status of the request.

    • intent

      protected Enumeration<DeviceRequest.RequestIntent> intent
      Whether the request is a proposal, plan, an original order or a reflex order.

    • priority

      protected Enumeration<DeviceRequest.RequestPriority> priority
      Indicates how quickly the {{title}} should be addressed with respect to other requests.

    • code

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

    • parameter

      protected List<DeviceRequest.DeviceRequestParameterComponent> parameter
      Specific parameters for the ordered item. For example, the prism value for lenses.

    • subject

      protected Reference subject
      The patient who will use the device.

    • subjectTarget

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

    • encounter

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

    • encounterTarget

      protected Encounter encounterTarget
      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".

    • authoredOn

      protected DateTimeType authoredOn
      When the request transitioned to being actionable.

    • requester

      protected Reference requester
      The individual who initiated the request and has responsibility for its activation.

    • requesterTarget

      protected Resource requesterTarget
      The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)

    • performerType

      protected CodeableConcept performerType
      Desired type of performer for doing the diagnostic testing.

    • performer

      protected Reference performer
      The desired performer for doing the diagnostic testing.

    • performerTarget

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

    • reasonCode

      protected List<CodeableConcept> reasonCode
      Reason or justification for the use of this device.

    • reasonReference

      protected List<Reference> reasonReference
      Reason or justification for the use of this device.

    • reasonReferenceTarget

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

    • insurance

      protected List<Reference> insurance
      Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

    • insuranceTarget

      protected List<Resource> insuranceTarget
      The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.)

    • supportingInfo

      protected List<Reference> supportingInfo
      Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body 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 include where on the subject's body 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.

    • relevantHistory

      protected List<Reference> relevantHistory
      Key events in the history of the request.

    • relevantHistoryTarget

      protected List<Provenance> relevantHistoryTarget
      The actual objects that are the target of the reference (Key events in the history of the request.)

    • SP_REQUESTER

      public static final String SP_REQUESTER
      Search parameter: requester

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

      See Also:

    • 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

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

      public static final String SP_INSURANCE
      Search parameter: insurance

      Description: Associated insurance coverage
      Type: reference
      Path: DeviceRequest.insurance

      See Also:

    • INSURANCE

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

      Description: Associated insurance coverage
      Type: reference
      Path: DeviceRequest.insurance

    • INCLUDE_INSURANCE

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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:

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

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

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

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

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

      public static final String SP_INSTANTIATES_CANONICAL
      Search parameter: instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: DeviceRequest.instantiatesCanonical

      See Also:

    • INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
      Fluent Client search parameter constant for instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: DeviceRequest.instantiatesCanonical

    • INCLUDE_INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:instantiates-canonical".

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Encounter during which request was created
      Type: reference
      Path: DeviceRequest.encounter

      See Also:

    • ENCOUNTER

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

      Description: Encounter during which request was created
      Type: reference
      Path: DeviceRequest.encounter

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

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

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

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

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

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Individual the service is ordered for
      Type: reference
      Path: DeviceRequest.subject

      See Also:

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

      public static final String SP_INSTANTIATES_URI
      Search parameter: instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: DeviceRequest.instantiatesUri

      See Also:

    • INSTANTIATES_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
      Fluent Client search parameter constant for instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: DeviceRequest.instantiatesUri

    • SP_PRIOR_REQUEST

      public static final String SP_PRIOR_REQUEST
      Search parameter: prior-request

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

      See Also:

    • PRIOR_REQUEST

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRIOR_REQUEST
      Fluent Client search parameter constant for prior-request

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

    • INCLUDE_PRIOR_REQUEST

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PRIOR_REQUEST
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:prior-request".

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

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

    • 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

  • Constructor Details

  • Method Details