Class OrderResponse

  • 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 OrderResponse
    extends DomainResource
    A response to an order.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        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.
      • request

        protected Reference request
        A reference to the order that this is in response to.
      • requestTarget

        protected Order requestTarget
        The actual object that is the target of the reference (A reference to the order that this is in response to.)
      • date

        protected DateTimeType date
        The date and time at which this order response was made (created/posted).
      • who

        protected Reference who
        The person, organization, or device credited with making the response.
      • whoTarget

        protected Resource whoTarget
        The actual object that is the target of the reference (The person, organization, or device credited with making the response.)
      • description

        protected StringType description
        Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.
      • fulfillment

        protected List<Reference> fulfillment
        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.
      • fulfillmentTarget

        protected List<Resource> fulfillmentTarget
        The actual objects that are the target of the reference (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.)
      • SP_FULFILLMENT

        public static final String SP_FULFILLMENT
        Search parameter: fulfillment

        Description: Details of the outcome of performing the order
        Type: reference
        Path: OrderResponse.fulfillment

        See Also:
        Constant Field Values
      • FULFILLMENT

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

        Description: Details of the outcome of performing the order
        Type: reference
        Path: OrderResponse.fulfillment

      • 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".
      • SP_REQUEST

        public static final String SP_REQUEST
        Search parameter: request

        Description: The order that this is a response to
        Type: reference
        Path: OrderResponse.request

        See Also:
        Constant Field Values
      • REQUEST

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

        Description: The order that this is a response to
        Type: reference
        Path: OrderResponse.request

      • 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".
      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed
        Type: token
        Path: OrderResponse.orderStatus

        See Also:
        Constant Field Values
      • CODE

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

        Description: pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed
        Type: token
        Path: OrderResponse.orderStatus

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: When the response was made
        Type: date
        Path: OrderResponse.date

        See Also:
        Constant Field Values
      • DATE

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

        Description: When the response was made
        Type: date
        Path: OrderResponse.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: 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

      • SP_WHO

        public static final String SP_WHO
        Search parameter: who

        Description: Who made the response
        Type: reference
        Path: OrderResponse.who

        See Also:
        Constant Field Values
      • WHO

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

        Description: Who made the response
        Type: reference
        Path: OrderResponse.who

      • 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

      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        identifier (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 Identifier addIdentifier()
        Returns:
        identifier (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.)
      • getRequestTarget

        public Order getRequestTarget()
        Returns:
        request The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to the order that this is in response to.)
      • setRequestTarget

        public OrderResponse setRequestTarget​(Order value)
        Parameters:
        value - request The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A reference to the order that this is in response to.)
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date and time at which this order response was made (created/posted).). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • hasDate

        public boolean hasDate()
      • setDateElement

        public OrderResponse setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date and time at which this order response was made (created/posted).). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • getDate

        public Date getDate()
        Returns:
        The date and time at which this order response was made (created/posted).
      • setDate

        public OrderResponse setDate​(Date value)
        Parameters:
        value - The date and time at which this order response was made (created/posted).
      • getWho

        public Reference getWho()
        Returns:
        who (The person, organization, or device credited with making the response.)
      • hasWho

        public boolean hasWho()
      • setWho

        public OrderResponse setWho​(Reference value)
        Parameters:
        value - who (The person, organization, or device credited with making the response.)
      • getWhoTarget

        public Resource getWhoTarget()
        Returns:
        who The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person, organization, or device credited with making the response.)
      • setWhoTarget

        public OrderResponse setWhoTarget​(Resource value)
        Parameters:
        value - who The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person, organization, or device credited with making the response.)
      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • setDescriptionElement

        public OrderResponse setDescriptionElement​(StringType value)
        Parameters:
        value - description (Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • getDescription

        public String getDescription()
        Returns:
        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 value)
        Parameters:
        value - Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.
      • getFulfillment

        public List<ReferencegetFulfillment()
        Returns:
        fulfillment (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 Reference addFulfillment()
        Returns:
        fulfillment (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.)
      • getFulfillmentTarget

        public List<ResourcegetFulfillmentTarget()
        Returns:
        fulfillment (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource