Class RequestGroup

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 RequestGroup extends DomainResource
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
See Also:
Serialized Form
  • Field Details

    • identifier

      Allows a service to provide a unique, business identifier for the request.
    • definition

      A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    • definitionTarget

      The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)
    • basedOn

      protected List<Reference> basedOn
      A plan, proposal or order that is fulfilled in whole or in part by this request.
    • basedOnTarget

      The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this request.)
    • replaces

      protected List<Reference> replaces
      Completed or terminated request(s) whose function is taken by this new request.
    • replacesTarget

      The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)
    • groupIdentifier

      A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
    • status

      The current state of the request. For request groups, the status reflects the status of all the requests in the group.
    • intent

      Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
    • priority

      Indicates how quickly the request should be addressed with respect to other requests.
    • subject

      protected Reference subject
      The subject for which the request group was created.
    • subjectTarget

      The actual object that is the target of the reference (The subject for which the request group was created.)
    • context

      protected Reference context
      Describes the context of the request group, if any.
    • contextTarget

      The actual object that is the target of the reference (Describes the context of the request group, if any.)
    • authoredOn

      Indicates when the request group was created.
    • author

      protected Reference author
      Provides a reference to the author of the request group.
    • authorTarget

      The actual object that is the target of the reference (Provides a reference to the author of the request group.)
    • reason

      protected Type reason
      Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
    • note

      protected List<Annotation> note
      Provides a mechanism to communicate additional information about the response.
    • action

      The actions, if any, produced by the evaluation of the artifact.
    • SP_AUTHORED

      public static final String SP_AUTHORED
      Search parameter: authored

      Description: The date the request group was authored
      Type: date
      Path: RequestGroup.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: The date the request group was authored
      Type: date
      Path: RequestGroup.authoredOn

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifiers for the request group
      Type: token
      Path: RequestGroup.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: External identifiers for the request group
      Type: token
      Path: RequestGroup.identifier

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: The subject that the request group is about
      Type: reference
      Path: RequestGroup.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: The subject that the request group is about
      Type: reference
      Path: RequestGroup.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 "RequestGroup:subject".
    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter: author

      Description: The author of the request group
      Type: reference
      Path: RequestGroup.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: The author of the request group
      Type: reference
      Path: RequestGroup.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 "RequestGroup:author".
    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: The encounter the request group applies to
      Type: reference
      Path: RequestGroup.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: The encounter the request group applies to
      Type: reference
      Path: RequestGroup.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 "RequestGroup:encounter".
    • SP_PRIORITY

      public static final String SP_PRIORITY
      Search parameter: priority

      Description: The priority of the request group
      Type: token
      Path: RequestGroup.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: The priority of the request group
      Type: token
      Path: RequestGroup.priority

    • SP_INTENT

      public static final String SP_INTENT
      Search parameter: intent

      Description: The intent of the request group
      Type: token
      Path: RequestGroup.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: The intent of the request group
      Type: token
      Path: RequestGroup.intent

    • SP_PARTICIPANT

      public static final String SP_PARTICIPANT
      Search parameter: participant

      Description: The participant in the requests in the group
      Type: reference
      Path: RequestGroup.action.participant

      See Also:
      Constant Field Values
    • PARTICIPANT

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

      Description: The participant in the requests in the group
      Type: reference
      Path: RequestGroup.action.participant

    • INCLUDE_PARTICIPANT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "RequestGroup:participant".
    • SP_GROUP_IDENTIFIER

      public static final String SP_GROUP_IDENTIFIER
      Search parameter: group-identifier

      Description: The group identifier for the request group
      Type: token
      Path: RequestGroup.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: The group identifier for the request group
      Type: token
      Path: RequestGroup.groupIdentifier

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: The identity of a patient to search for request groups
      Type: reference
      Path: RequestGroup.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: The identity of a patient to search for request groups
      Type: reference
      Path: RequestGroup.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 "RequestGroup:patient".
    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: The context the request group applies to
      Type: reference
      Path: RequestGroup.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: The context the request group applies to
      Type: reference
      Path: RequestGroup.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 "RequestGroup:context".
    • SP_DEFINITION

      public static final String SP_DEFINITION
      Search parameter: definition

      Description: The definition from which the request group is realized
      Type: reference
      Path: RequestGroup.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: The definition from which the request group is realized
      Type: reference
      Path: RequestGroup.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 "RequestGroup:definition".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the request group
      Type: token
      Path: RequestGroup.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: The status of the request group
      Type: token
      Path: RequestGroup.status

  • Constructor Details

  • Method Details