ca.uhn.fhir.model.dstu2.resource

Class OrderResponse

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.OrderResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource

public class OrderResponse
extends BaseResource
implements 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 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 TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
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_IDENTIFIER Search parameter constant for identifier
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.dstu2.resource.BaseResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
OrderResponse()

Method Summary

Modifier and Type	Method and Description
ResourceReferenceDt	addFulfillment() Adds and returns a new value for fulfillment ()
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (id)
OrderResponse	addIdentifier(IdentifierDt theValue) Adds a given new value for identifier (id)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
Date	getDate() Gets the value(s) for date (when.recorded).
DateTimeDt	getDateElement() Gets the value(s) for date (when.recorded).
String	getDescription() Gets the value(s) for description ().
StringDt	getDescriptionElement() Gets the value(s) for description ().
List<ResourceReferenceDt>	getFulfillment() Gets the value(s) for fulfillment ().
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (id).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (id), creating it if it does not already exist.
String	getOrderStatus() Gets the value(s) for orderStatus ().
BoundCodeDt<OrderStatusEnum>	getOrderStatusElement() Gets the value(s) for orderStatus ().
ResourceReferenceDt	getRequest() Gets the value(s) for request ().
String	getResourceName()
FhirVersionEnum	getStructureFhirVersionEnum()
ResourceReferenceDt	getWho() Gets the value(s) for who (who.actor).
boolean	isEmpty()
OrderResponse	setDate(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for date (when.recorded)
OrderResponse	setDate(DateTimeDt theValue) Sets the value(s) for date (when.recorded)
OrderResponse	setDateWithSecondsPrecision(Date theDate) Sets the value for date (when.recorded)
OrderResponse	setDescription(String theString) Sets the value for description ()
OrderResponse	setDescription(StringDt theValue) Sets the value(s) for description ()
OrderResponse	setFulfillment(List<ResourceReferenceDt> theValue) Sets the value(s) for fulfillment ()
OrderResponse	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (id)
OrderResponse	setOrderStatus(BoundCodeDt<OrderStatusEnum> theValue) Sets the value(s) for orderStatus ()
OrderResponse	setOrderStatus(OrderStatusEnum theValue) Sets the value(s) for orderStatus ()
OrderResponse	setRequest(ResourceReferenceDt theValue) Sets the value(s) for request ()
OrderResponse	setWho(ResourceReferenceDt theValue) Sets the value(s) for who (who.actor)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getIdElement, setId, setId

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

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

SP_CODE

public static final String SP_CODE

Search parameter constant for code

Description:
Type: token
Path: OrderResponse.orderStatus

See Also:

Constant Field Values

CODE

public static final TokenClientParam CODE

Fluent Client search parameter constant for code

Description:
Type: token
Path: OrderResponse.orderStatus

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

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 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 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 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 Include INCLUDE_WHO

Constant for fluent queries to be used to add include statements. Specifies the path value of "OrderResponse:who".

Constructor Detail

OrderResponse

public OrderResponse()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getIdentifier

public List<IdentifierDt> getIdentifier()

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

setRequest

public OrderResponse setRequest(ResourceReferenceDt theValue)

Sets the value(s) for request ()

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

getDateElement

public 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. 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.recorded)

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.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 BoundCodeDt<OrderStatusEnum> getOrderStatusElement()

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. Will not return null.

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

setOrderStatus

public OrderResponse setOrderStatus(BoundCodeDt<OrderStatusEnum> theValue)

Sets the value(s) for orderStatus ()

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

setOrderStatus

public OrderResponse setOrderStatus(OrderStatusEnum theValue)

Sets the value(s) for orderStatus ()

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

getDescriptionElement

public 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. 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 ()

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<ResourceReferenceDt> getFulfillment()

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 IResource

getStructureFhirVersionEnum

public FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface IResource

Specified by:

getStructureFhirVersionEnum in interface IBaseResource