Class OrderResponse

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class OrderResponse
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR OrderResponse Resource (workflow.order)

    Definition: A response to an order.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/OrderResponse

    See Also:
    Serialized Form
    • Field Detail

      • REQUEST

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

        Description:
        Type: reference
        Path: OrderResponse.request

      • DATE

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

        Description:
        Type: date
        Path: OrderResponse.date

      • WHO

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

        Description:
        Type: reference
        Path: OrderResponse.who

      • CODE

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

        Description:
        Type: token
        Path: OrderResponse.orderStatus

      • FULFILLMENT

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

        Description:
        Type: reference
        Path: OrderResponse.fulfillment

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: Identifiers assigned to this order by the orderer or by the receiver
        Type: token
        Path: OrderResponse.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 by the orderer or by the receiver
        Type: token
        Path: OrderResponse.identifier

      • INCLUDE_FULFILLMENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_FULFILLMENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse:fulfillment".
      • INCLUDE_REQUEST

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST
        Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse:request".
      • INCLUDE_WHO

        public static final ca.uhn.fhir.model.api.Include INCLUDE_WHO
        Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse:who".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems

      • setIdentifier

        public OrderResponse setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems

      • addIdentifier

        public OrderResponse addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems

      • getRequest

        public ResourceReferenceDt getRequest()
        Gets the value(s) for request (). creating it if it does not exist. Will not return null.

        Definition: A reference to the order that this is in response to

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

        Definition: The date and time at which this order response was made (created/posted)

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The date and time at which this order response was made (created/posted)

      • setDate

        public OrderResponse setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.recorded)

        Definition: The date and time at which this order response was made (created/posted)

      • setDate

        public OrderResponse setDate​(Date theDate,
                                     ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: The date and time at which this order response was made (created/posted)

      • setDateWithSecondsPrecision

        public OrderResponse setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date (when.recorded)

        Definition: The date and time at which this order response was made (created/posted)

      • getWho

        public ResourceReferenceDt getWho()
        Gets the value(s) for who (who.actor). creating it if it does not exist. Will not return null.

        Definition: The person, organization, or device credited with making the response

      • setWho

        public OrderResponse setWho​(ResourceReferenceDt theValue)
        Sets the value(s) for who (who.actor)

        Definition: The person, organization, or device credited with making the response

      • getOrderStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<OrderStatusEnumgetOrderStatusElement()
        Gets the value(s) for orderStatus (). creating it if it does not exist. Will not return null.

        Definition: What this response says about the status of the original order

      • getOrderStatus

        public String getOrderStatus()
        Gets the value(s) for orderStatus (). creating it if it does not exist. This method may return null.

        Definition: What this response says about the status of the original order

      • setOrderStatus

        public OrderResponse setOrderStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<OrderStatusEnum> theValue)
        Sets the value(s) for orderStatus ()

        Definition: What this response says about the status of the original order

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: Additional description about the response - e.g. a text description provided by a human user when making decisions about the order

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: Additional description about the response - e.g. a text description provided by a human user when making decisions about the order

      • setDescription

        public OrderResponse setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: Additional description about the response - e.g. a text description provided by a human user when making decisions about the order

      • setDescription

        public OrderResponse setDescription​(String theString)
        Sets the value for description ()

        Definition: Additional description about the response - e.g. a text description provided by a human user when making decisions about the order

      • getFulfillment

        public List<ResourceReferenceDtgetFulfillment()
        Gets the value(s) for fulfillment (). creating it if it does not exist. Will not return null.

        Definition: Links to resources that provide details of the outcome of performing the order; e.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order

      • setFulfillment

        public OrderResponse setFulfillment​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for fulfillment ()

        Definition: Links to resources that provide details of the outcome of performing the order; e.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order

      • addFulfillment

        public ResourceReferenceDt addFulfillment()
        Adds and returns a new value for fulfillment ()

        Definition: Links to resources that provide details of the outcome of performing the order; e.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource