OrderResponse (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.OrderResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class OrderResponse
extends BaseResource
implements IResource
```
HAPI/FHIR OrderResponse Resource (A response to an order)
Definition: A response to an order

Requirements:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ReferenceClientParam`	`FULFILLMENT` Fluent Client search parameter constant for fulfillment
`static Include`	`INCLUDE_FULFILLMENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REQUEST` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_WHO` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`REQUEST` Fluent Client search parameter constant for request
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_FULFILLMENT` Search parameter constant for fulfillment
`static String`	`SP_REQUEST` Search parameter constant for request
`static String`	`SP_WHO` Search parameter constant for who
`static ReferenceClientParam`	`WHO` Fluent Client search parameter constant for who

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

OrderResponse()

Constructors
Constructor and Description
`OrderResponse()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addFulfillment()` Adds and returns a new value for fulfillment (Details of the outcome of performing the order)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`OrderResponse`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`OrderResponse`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`IDatatype`	`getAuthority()` Gets the value(s) for authority[x] (If required by policy).
`BoundCodeDt<OrderOutcomeStatusEnum>`	`getCode()` Gets the value(s) for code (pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| complete).
`DateTimeDt`	`getDate()` Gets the value(s) for date (When the response was made).
`StringDt`	`getDescription()` Gets the value(s) for description (Additional description of the response).
`List<ResourceReferenceDt>`	`getFulfillment()` Gets the value(s) for fulfillment (Details of the outcome of performing the order).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Identifiers assigned to this order by the orderer or by the receiver).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Identifiers assigned to this order by the orderer or by the receiver), creating it if it does not already exist.
`ResourceReferenceDt`	`getRequest()` Gets the value(s) for request (The order that this is a response to).
`ResourceReferenceDt`	`getWho()` Gets the value(s) for who (Who made the response).
`boolean`	`isEmpty()`
`OrderResponse`	`setAuthority(IDatatype theValue)` Sets the value(s) for authority[x] (If required by policy)
`OrderResponse`	`setCode(BoundCodeDt<OrderOutcomeStatusEnum> theValue)` Sets the value(s) for code (pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| complete)
`OrderResponse`	`setCode(OrderOutcomeStatusEnum theValue)` Sets the value(s) for code (pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| complete)
`OrderResponse`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (When the response was made)
`OrderResponse`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (When the response was made)
`OrderResponse`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (When the response was made)
`OrderResponse`	`setDescription(String theString)` Sets the value for description (Additional description of the response)
`OrderResponse`	`setDescription(StringDt theValue)` Sets the value(s) for description (Additional description of the response)
`OrderResponse`	`setFulfillment(List<ResourceReferenceDt> theValue)` Sets the value(s) for fulfillment (Details of the outcome of performing the order)
`OrderResponse`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`OrderResponse`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request (The order that this is a response to)
`OrderResponse`	`setWho(ResourceReferenceDt theValue)` Sets the value(s) for who (Who made the response)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_REQUEST
```
public static final String SP_REQUEST
```
    Search parameter constant for request
    Description:
    Type: reference
    Path: OrderResponse.request
    
    See Also:
    Constant Field Values
  - REQUEST
```
public static final ReferenceClientParam REQUEST
```
    Fluent Client search parameter constant for request
    Description:
    Type: reference
    Path: OrderResponse.request
  - INCLUDE_REQUEST
```
public static final Include INCLUDE_REQUEST
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse.request".
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: OrderResponse.date
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: OrderResponse.date
  - SP_WHO
```
public static final String SP_WHO
```
    Search parameter constant for who
    Description:
    Type: reference
    Path: OrderResponse.who
    
    See Also:
    Constant Field Values
  - WHO
```
public static final ReferenceClientParam WHO
```
    Fluent Client search parameter constant for who
    Description:
    Type: reference
    Path: OrderResponse.who
  - INCLUDE_WHO
```
public static final Include INCLUDE_WHO
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse.who".
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description:
    Type: token
    Path: OrderResponse.code
    
    See Also:
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description:
    Type: token
    Path: OrderResponse.code
  - SP_FULFILLMENT
```
public static final String SP_FULFILLMENT
```
    Search parameter constant for fulfillment
    Description:
    Type: reference
    Path: OrderResponse.fulfillment
    
    See Also:
    Constant Field Values
  - FULFILLMENT
```
public static final ReferenceClientParam FULFILLMENT
```
    Fluent Client search parameter constant for fulfillment
    Description:
    Type: reference
    Path: OrderResponse.fulfillment
  - INCLUDE_FULFILLMENT
```
public static final Include INCLUDE_FULFILLMENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse.fulfillment".
- Constructor Detail
  - OrderResponse
```
public OrderResponse()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (Identifiers assigned to this order by the orderer or by the receiver). 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 (Identifiers assigned to this order by the orderer or by the receiver)
    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 (Identifiers assigned to this order by the orderer or by the receiver)
    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
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Identifiers assigned to this order by the orderer or by the receiver), 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
  - addIdentifier
```
public OrderResponse addIdentifier(IdentifierUseEnum theUse,
                          String theSystem,
                          String theValue,
                          String theLabel)
```
    Adds a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public OrderResponse addIdentifier(String theSystem,
                          String theValue)
```
    Adds a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (The order that this is a response to). creating it if it does not exist. Will not return null.
    Definition: A reference to the order that this is in response to
  - setRequest
```
public OrderResponse setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request (The order that this is a response to)
    Definition: A reference to the order that this is in response to
  - getDate
```
public DateTimeDt getDate()
```
    Gets the value(s) for date (When the response was made). 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)
  - setDate
```
public OrderResponse setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (When the response was made)
    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 the response was made)
    Definition: The date and time at which this order response was made (created/posted)
  - setDate
```
public OrderResponse setDate(Date theDate,
                    TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (When the response was made)
    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 made the response). 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 made the response)
    Definition: The person, organization, or device credited with making the response
  - getAuthority
```
public IDatatype getAuthority()
```
    Gets the value(s) for authority[x] (If required by policy). creating it if it does not exist. Will not return null.
    Definition: A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection
  - setAuthority
```
public OrderResponse setAuthority(IDatatype theValue)
```
    Sets the value(s) for authority[x] (If required by policy)
    Definition: A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection
  - getCode
```
public BoundCodeDt<OrderOutcomeStatusEnum> getCode()
```
    Gets the value(s) for code (pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete). creating it if it does not exist. Will not return null.
    Definition: What this response says about the status of the original order
  - setCode
```
public OrderResponse setCode(BoundCodeDt<OrderOutcomeStatusEnum> theValue)
```
    Sets the value(s) for code (pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete)
    Definition: What this response says about the status of the original order
  - setCode
```
public OrderResponse setCode(OrderOutcomeStatusEnum theValue)
```
    Sets the value(s) for code (pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete)
    Definition: What this response says about the status of the original order
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for description (Additional description of the response). 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
  - setDescription
```
public OrderResponse setDescription(StringDt theValue)
```
    Sets the value(s) for description (Additional description of the response)
    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 (Additional description of the response)
    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<ResourceReferenceDt> getFulfillment()
```
    Gets the value(s) for fulfillment (Details of the outcome of performing the order). 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 (Details of the outcome of performing the order)
    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 (Details of the outcome of performing the order)
    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

Class OrderResponse

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_REQUEST

REQUEST

INCLUDE_REQUEST

SP_DATE

DATE

SP_WHO

WHO

INCLUDE_WHO

SP_CODE

CODE

SP_FULFILLMENT

FULFILLMENT

INCLUDE_FULFILLMENT

Constructor Detail

OrderResponse

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getRequest

setRequest

getDate

setDate

setDateWithSecondsPrecision

setDate

getWho

setWho

getAuthority

setAuthority

getCode

setCode

setCode

getDescription

setDescription

setDescription

getFulfillment

setFulfillment

addFulfillment