org.hl7.fhir.dstu2016may.model

Class OrderResponse

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.model.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderResponse.OrderStatus
static class	OrderResponse.OrderStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
static ca.uhn.fhir.rest.gclient.TokenClientParam	CODE Fluent Client search parameter constant for code
protected DateTimeType	date The date and time at which this order response was made (created/posted).
static ca.uhn.fhir.rest.gclient.DateClientParam	DATE Fluent Client search parameter constant for date
protected StringType	description Additional description about the response - e.g.
protected List<Reference>	fulfillment Links to resources that provide details of the outcome of performing the order; e.g.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	FULFILLMENT Fluent Client search parameter constant for fulfillment
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.
protected List<Identifier>	identifier Identifiers assigned to this order.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_FULFILLMENT Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_REQUEST Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_WHO Constant for fluent queries to be used to add include statements.
protected Enumeration<OrderResponse.OrderStatus>	orderStatus What this response says about the status of the original order.
protected Reference	request A reference to the order that this is in response to.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUEST Fluent Client search parameter constant for request
protected Order	requestTarget The actual object that is the target of the reference (A reference to the order that this is in response to.)
static String	SP_CODE Search parameter: code
static String	SP_DATE Search parameter: date
static String	SP_FULFILLMENT Search parameter: fulfillment
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_REQUEST Search parameter: request
static String	SP_WHO Search parameter: who
protected Reference	who The person, organization, or device credited with making the response.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	WHO Fluent Client search parameter constant for who
protected Resource	whoTarget The actual object that is the target of the reference (The person, organization, or device credited with making the response.)

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

id, implicitRules, language, meta

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

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() Constructor
OrderResponse(Reference request, Enumeration<OrderResponse.OrderStatus> orderStatus) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Reference	addFulfillment()
OrderResponse	addFulfillment(Reference t)
Identifier	addIdentifier()
OrderResponse	addIdentifier(Identifier t)
OrderResponse	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
StringType	getDescriptionElement()
List<Reference>	getFulfillment()
List<Resource>	getFulfillmentTarget()
List<Identifier>	getIdentifier()
OrderResponse.OrderStatus	getOrderStatus()
Enumeration<OrderResponse.OrderStatus>	getOrderStatusElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getRequest()
Order	getRequestTarget()
ResourceType	getResourceType()
Reference	getWho()
Resource	getWhoTarget()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasFulfillment()
boolean	hasIdentifier()
boolean	hasOrderStatus()
boolean	hasOrderStatusElement()
boolean	hasRequest()
boolean	hasWho()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
OrderResponse	setDate(Date value)
OrderResponse	setDateElement(DateTimeType value)
OrderResponse	setDescription(String value)
OrderResponse	setDescriptionElement(StringType value)
OrderResponse	setOrderStatus(OrderResponse.OrderStatus value)
OrderResponse	setOrderStatusElement(Enumeration<OrderResponse.OrderStatus> value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
OrderResponse	setRequest(Reference value)
OrderResponse	setRequestTarget(Order value)
OrderResponse	setWho(Reference value)
OrderResponse	setWhoTarget(Resource value)
protected OrderResponse	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

orderStatus

protected Enumeration<OrderResponse.OrderStatus> orderStatus

What this response says about the status of the original order.

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

Constructor Detail

OrderResponse

public OrderResponse()

Constructor

OrderResponse

public OrderResponse(Reference request,
                     Enumeration<OrderResponse.OrderStatus> orderStatus)

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

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

hasIdentifier

public boolean hasIdentifier()

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

addIdentifier

public OrderResponse addIdentifier(Identifier t)

getRequest

public Reference getRequest()

Returns:

request (A reference to the order that this is in response to.)

hasRequest

public boolean hasRequest()

setRequest

public OrderResponse setRequest(Reference value)

Parameters:

value - request (A reference to the order that this is in response to.)

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

hasDateElement

public boolean hasDateElement()

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

getOrderStatusElement

public Enumeration<OrderResponse.OrderStatus> getOrderStatusElement()

Returns:

orderStatus (What this response says about the status of the original order.). This is the underlying object with id, value and extensions. The accessor "getOrderStatus" gives direct access to the value

hasOrderStatusElement

public boolean hasOrderStatusElement()

hasOrderStatus

public boolean hasOrderStatus()

setOrderStatusElement

public OrderResponse setOrderStatusElement(Enumeration<OrderResponse.OrderStatus> value)

Parameters:

value - orderStatus (What this response says about the status of the original order.). This is the underlying object with id, value and extensions. The accessor "getOrderStatus" gives direct access to the value

getOrderStatus

public OrderResponse.OrderStatus getOrderStatus()

Returns:

What this response says about the status of the original order.

setOrderStatus

public OrderResponse setOrderStatus(OrderResponse.OrderStatus value)

Parameters:

value - What this response says about the status of the original order.

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

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

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

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

hasFulfillment

public boolean hasFulfillment()

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

addFulfillment

public OrderResponse addFulfillment(Reference t)

getFulfillmentTarget

public List<Resource> getFulfillmentTarget()

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

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

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

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public OrderResponse copy()

Specified by:

copy in class DomainResource

typedCopy

protected OrderResponse typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource