Package com.ibm.fhir.model.resource

Class RequestGroup

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
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".

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Allows a service to provide a unique, business identifier for the request.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getInstantiatesCanonical

        public List<Canonical> getInstantiatesCanonical()
        A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getInstantiatesUri

        public List<Uri> getInstantiatesUri()
        A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
        Returns:
        An unmodifiable list containing immutable objects of type Uri that may be empty.

      • getBasedOn

        public List<Reference> getBasedOn()
        A plan, proposal or order that is fulfilled in whole or in part by this request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getReplaces

        public List<Reference> getReplaces()
        Completed or terminated request(s) whose function is taken by this new request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getGroupIdentifier

        public Identifier getGroupIdentifier()
        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.
        Returns:
        An immutable object of type Identifier that may be null.

      • getStatus

        public RequestStatus getStatus()
        The current state of the request. For request groups, the status reflects the status of all the requests in the group.
        Returns:
        An immutable object of type RequestStatus that is non-null.

      • getIntent

        public RequestIntent getIntent()
        Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
        Returns:
        An immutable object of type RequestIntent that is non-null.

      • getPriority

        public RequestPriority getPriority()
        Indicates how quickly the request should be addressed with respect to other requests.
        Returns:
        An immutable object of type RequestPriority that may be null.

      • getCode

        public CodeableConcept getCode()
        A code that identifies what the overall request group is.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSubject

        public Reference getSubject()
        The subject for which the request group was created.
        Returns:
        An immutable object of type Reference that may be null.

      • getEncounter

        public Reference getEncounter()
        Describes the context of the request group, if any.
        Returns:
        An immutable object of type Reference that may be null.

      • getAuthoredOn

        public DateTime getAuthoredOn()
        Indicates when the request group was created.
        Returns:
        An immutable object of type DateTime that may be null.

      • getAuthor

        public Reference getAuthor()
        Provides a reference to the author of the request group.
        Returns:
        An immutable object of type Reference that may be null.

      • getReasonCode

        public List<CodeableConcept> getReasonCode()
        Describes the reason for the request group in coded or textual form.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReasonReference

        public List<Reference> getReasonReference()
        Indicates another resource whose existence justifies this request group.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getNote

        public List<Annotation> getNote()
        Provides a mechanism to communicate additional information about the response.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getAction

        public List<RequestGroup.Action> getAction()
        The actions, if any, produced by the evaluation of the artifact.
        Returns:
        An unmodifiable list containing immutable objects of type RequestGroup.Action that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object