Class ProcedureRequest

  • 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 ProcedureRequest
    extends DomainResource
    A record of a request for diagnostic investigations, treatments, or operations to be performed.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
      • definitionTarget

        protected List<Resource> definitionTarget
        The actual objects that are the target of the reference (Protocol or definition followed 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.)
      • replaces

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

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

        protected Identifier requisition
        A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
      • doNotPerform

        protected BooleanType doNotPerform
        Set this to true if the record is saying that the procedure should NOT be performed.
      • category

        protected List<CodeableConcept> category
        A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
      • code

        protected CodeableConcept code
        A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
      • subject

        protected Reference subject
        On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
      • context

        protected Reference context
        An encounter or episode of care that provides additional information about the healthcare context in which this request is made.
      • contextTarget

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

        protected Type occurrence
        The date/time at which the diagnostic testing should occur.
      • asNeeded

        protected Type asNeeded
        If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
      • performer

        protected Reference performer
        The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
      • performerTarget

        protected Resource performerTarget
        The actual object that is the target of the reference (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)
      • reasonCode

        protected List<CodeableConcept> reasonCode
        An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
      • reasonReference

        protected List<Reference> reasonReference
        Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.)
      • supportingInfo

        protected List<Reference> supportingInfo
        Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
      • supportingInfoTarget

        protected List<Resource> supportingInfoTarget
        The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)
      • specimen

        protected List<Reference> specimen
        One or more specimens that the laboratory procedure will use.
      • specimenTarget

        protected List<Specimen> specimenTarget
        The actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)
      • bodySite

        protected List<CodeableConcept> bodySite
        Anatomic location where the procedure should be performed. This is the target site.
      • note

        protected List<Annotation> note
        Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
      • SP_AUTHORED

        public static final String SP_AUTHORED
        Search parameter: authored

        Description: Date request signed
        Type: date
        Path: ProcedureRequest.authoredOn

        See Also:
        Constant Field Values
      • AUTHORED

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

        Description: Date request signed
        Type: date
        Path: ProcedureRequest.authoredOn

      • SP_REQUESTER

        public static final String SP_REQUESTER
        Search parameter: requester

        Description: Individual making the request
        Type: reference
        Path: ProcedureRequest.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: Individual making the request
        Type: reference
        Path: ProcedureRequest.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 "ProcedureRequest:requester".
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Identifiers assigned to this order
        Type: token
        Path: ProcedureRequest.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: Identifiers assigned to this order
        Type: token
        Path: ProcedureRequest.identifier

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: What is being requested/ordered
        Type: token
        Path: ProcedureRequest.code

        See Also:
        Constant Field Values
      • CODE

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

        Description: What is being requested/ordered
        Type: token
        Path: ProcedureRequest.code

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: performer

        Description: Requested perfomer
        Type: reference
        Path: ProcedureRequest.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: Requested perfomer
        Type: reference
        Path: ProcedureRequest.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 "ProcedureRequest:performer".
      • REQUISITION

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

        Description: Composite Request ID
        Type: token
        Path: ProcedureRequest.requisition

      • SP_REPLACES

        public static final String SP_REPLACES
        Search parameter: replaces

        Description: What request replaces
        Type: reference
        Path: ProcedureRequest.replaces

        See Also:
        Constant Field Values
      • REPLACES

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

        Description: What request replaces
        Type: reference
        Path: ProcedureRequest.replaces

      • INCLUDE_REPLACES

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REPLACES
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcedureRequest:replaces".
      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Search by subject
        Type: reference
        Path: ProcedureRequest.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: ProcedureRequest.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 "ProcedureRequest:subject".
      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: An encounter in which this request is made
        Type: reference
        Path: ProcedureRequest.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: An encounter in which this request is made
        Type: reference
        Path: ProcedureRequest.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 "ProcedureRequest:encounter".
      • SP_OCCURRENCE

        public static final String SP_OCCURRENCE
        Search parameter: occurrence

        Description: When procedure should occur
        Type: date
        Path: ProcedureRequest.occurrence[x]

        See Also:
        Constant Field Values
      • OCCURRENCE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam OCCURRENCE
        Fluent Client search parameter constant for occurrence

        Description: When procedure should occur
        Type: date
        Path: ProcedureRequest.occurrence[x]

      • SP_PRIORITY

        public static final String SP_PRIORITY
        Search parameter: priority

        Description: routine | urgent | asap | stat
        Type: token
        Path: ProcedureRequest.priority

        See Also:
        Constant Field Values
      • PRIORITY

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

        Description: routine | urgent | asap | stat
        Type: token
        Path: ProcedureRequest.priority

      • SP_INTENT

        public static final String SP_INTENT
        Search parameter: intent

        Description: proposal | plan | order +
        Type: token
        Path: ProcedureRequest.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 | order +
        Type: token
        Path: ProcedureRequest.intent

      • PERFORMER_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PERFORMER_TYPE
        Fluent Client search parameter constant for performer-type

        Description: Performer role
        Type: token
        Path: ProcedureRequest.performerType

      • SP_BASED_ON

        public static final String SP_BASED_ON
        Search parameter: based-on

        Description: What request fulfills
        Type: reference
        Path: ProcedureRequest.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: What request fulfills
        Type: reference
        Path: ProcedureRequest.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 "ProcedureRequest:based-on".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Search by subject - a patient
        Type: reference
        Path: ProcedureRequest.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: ProcedureRequest.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 "ProcedureRequest:patient".
      • SP_SPECIMEN

        public static final String SP_SPECIMEN
        Search parameter: specimen

        Description: Specimen to be tested
        Type: reference
        Path: ProcedureRequest.specimen

        See Also:
        Constant Field Values
      • SPECIMEN

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

        Description: Specimen to be tested
        Type: reference
        Path: ProcedureRequest.specimen

      • INCLUDE_SPECIMEN

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SPECIMEN
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcedureRequest:specimen".
      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

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

        See Also:
        Constant Field Values
      • CONTEXT

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

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

      • INCLUDE_CONTEXT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcedureRequest:context".
      • SP_DEFINITION

        public static final String SP_DEFINITION
        Search parameter: definition

        Description: Protocol or definition
        Type: reference
        Path: ProcedureRequest.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
        Type: reference
        Path: ProcedureRequest.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 "ProcedureRequest:definition".
      • SP_BODY_SITE

        public static final String SP_BODY_SITE
        Search parameter: body-site

        Description: Where procedure is going to be done
        Type: token
        Path: ProcedureRequest.bodySite

        See Also:
        Constant Field Values
      • BODY_SITE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODY_SITE
        Fluent Client search parameter constant for body-site

        Description: Where procedure is going to be done
        Type: token
        Path: ProcedureRequest.bodySite

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: draft | active | suspended | completed | entered-in-error | cancelled
        Type: token
        Path: ProcedureRequest.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: draft | active | suspended | completed | entered-in-error | cancelled
        Type: token
        Path: ProcedureRequest.status