ca.uhn.fhir.model.dstu.resource

Class Supply

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Supply

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Supply
extends BaseResource
implements IResource

HAPI/FHIR Supply Resource (A supply - request and provision)

Definition: A supply - a request for something, and provision of what is supplied

Requirements:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Supply.Dispense Block class for child element: Supply.dispense (Supply details)

Field Summary

Fields

Modifier and Type	Field and Description
static TokenClientParam	DISPENSEID Fluent Client search parameter constant for dispenseid
static TokenClientParam	DISPENSESTATUS Fluent Client search parameter constant for dispensestatus
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_DISPENSE_SUPPLIER Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static TokenClientParam	KIND Fluent Client search parameter constant for kind
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static String	SP_DISPENSEID Search parameter constant for dispenseid
static String	SP_DISPENSESTATUS Search parameter constant for dispensestatus
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_KIND Search parameter constant for kind
static String	SP_PATIENT Search parameter constant for patient
static String	SP_STATUS Search parameter constant for status
static String	SP_SUPPLIER Search parameter constant for supplier
static TokenClientParam	STATUS Fluent Client search parameter constant for status
static ReferenceClientParam	SUPPLIER Fluent Client search parameter constant for supplier

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

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Supply()

Method Summary

Methods

Modifier and Type	Method and Description
Supply.Dispense	addDispense() Adds and returns a new value for dispense (Supply details)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<Supply.Dispense>	getDispense() Gets the value(s) for dispense (Supply details).
Supply.Dispense	getDispenseFirstRep() Gets the first repetition for dispense (Supply details), creating it if it does not already exist.
IdentifierDt	getIdentifier() Gets the value(s) for identifier (Unique identifier).
BoundCodeableConceptDt<SupplyTypeEnum>	getKind() Gets the value(s) for kind (The kind of supply (central, non-stock, etc)).
ResourceReferenceDt	getOrderedItem() Gets the value(s) for orderedItem (Medication, Substance, or Device requested to be supplied).
ResourceReferenceDt	getPatient() Gets the value(s) for patient (Patient for whom the item is supplied).
BoundCodeDt<SupplyStatusEnum>	getStatus() Gets the value(s) for status (requested | dispensed | received | failed | cancelled).
boolean	isEmpty()
Supply	setDispense(List<Supply.Dispense> theValue) Sets the value(s) for dispense (Supply details)
Supply	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (Unique identifier)
Supply	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (Unique identifier)
Supply	setIdentifier(String theSystem, String theValue) Sets the value for identifier (Unique identifier)
Supply	setKind(BoundCodeableConceptDt<SupplyTypeEnum> theValue) Sets the value(s) for kind (The kind of supply (central, non-stock, etc))
Supply	setKind(SupplyTypeEnum theValue) Sets the value(s) for kind (The kind of supply (central, non-stock, etc))
Supply	setOrderedItem(ResourceReferenceDt theValue) Sets the value(s) for orderedItem (Medication, Substance, or Device requested to be supplied)
Supply	setPatient(ResourceReferenceDt theValue) Sets the value(s) for patient (Patient for whom the item is supplied)
Supply	setStatus(BoundCodeDt<SupplyStatusEnum> theValue) Sets the value(s) for status (requested | dispensed | received | failed | cancelled)
Supply	setStatus(SupplyStatusEnum theValue) Sets the value(s) for status (requested | dispensed | received | failed | cancelled)

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_KIND

public static final String SP_KIND

Search parameter constant for kind

Description:
Type: token
Path: Supply.kind

See Also:

Constant Field Values

KIND

public static final TokenClientParam KIND

Fluent Client search parameter constant for kind

Description:
Type: token
Path: Supply.kind

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description:
Type: token
Path: Supply.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description:
Type: token
Path: Supply.identifier

SP_STATUS

public static final String SP_STATUS

Search parameter constant for status

Description:
Type: token
Path: Supply.status

See Also:

Constant Field Values

STATUS

public static final TokenClientParam STATUS

Fluent Client search parameter constant for status

Description:
Type: token
Path: Supply.status

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description:
Type: reference
Path: Supply.patient

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description:
Type: reference
Path: Supply.patient

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Supply.patient".

SP_SUPPLIER

public static final String SP_SUPPLIER

Search parameter constant for supplier

Description:
Type: reference
Path: Supply.dispense.supplier

See Also:

Constant Field Values

SUPPLIER

public static final ReferenceClientParam SUPPLIER

Fluent Client search parameter constant for supplier

Description:
Type: reference
Path: Supply.dispense.supplier

INCLUDE_DISPENSE_SUPPLIER

public static final Include INCLUDE_DISPENSE_SUPPLIER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Supply.dispense.supplier".

SP_DISPENSEID

public static final String SP_DISPENSEID

Search parameter constant for dispenseid

Description:
Type: token
Path: Supply.dispense.identifier

See Also:

Constant Field Values

DISPENSEID

public static final TokenClientParam DISPENSEID

Fluent Client search parameter constant for dispenseid

Description:
Type: token
Path: Supply.dispense.identifier

SP_DISPENSESTATUS

public static final String SP_DISPENSESTATUS

Search parameter constant for dispensestatus

Description:
Type: token
Path: Supply.dispense.status

See Also:

Constant Field Values

DISPENSESTATUS

public static final TokenClientParam DISPENSESTATUS

Fluent Client search parameter constant for dispensestatus

Description:
Type: token
Path: Supply.dispense.status

Constructor Detail

Supply

public Supply()

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

getKind

public BoundCodeableConceptDt<SupplyTypeEnum> getKind()

Gets the value(s) for kind (The kind of supply (central, non-stock, etc)). creating it if it does not exist. Will not return null.

Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process

setKind

public Supply setKind(BoundCodeableConceptDt<SupplyTypeEnum> theValue)

Sets the value(s) for kind (The kind of supply (central, non-stock, etc))

Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process

setKind

public Supply setKind(SupplyTypeEnum theValue)

Sets the value(s) for kind (The kind of supply (central, non-stock, etc))

Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process

getIdentifier

public IdentifierDt getIdentifier()

Gets the value(s) for identifier (Unique identifier). creating it if it does not exist. Will not return null.

Definition: Unique identifier for this supply request

setIdentifier

public Supply setIdentifier(IdentifierDt theValue)

Sets the value(s) for identifier (Unique identifier)

Definition: Unique identifier for this supply request

setIdentifier

public Supply setIdentifier(IdentifierUseEnum theUse,
                   String theSystem,
                   String theValue,
                   String theLabel)

Sets the value for identifier (Unique identifier)

Definition: Unique identifier for this supply request

setIdentifier

public Supply setIdentifier(String theSystem,
                   String theValue)

Sets the value for identifier (Unique identifier)

Definition: Unique identifier for this supply request

getStatus

public BoundCodeDt<SupplyStatusEnum> getStatus()

Gets the value(s) for status (requested | dispensed | received | failed | cancelled). creating it if it does not exist. Will not return null.

Definition: Status of the supply request

setStatus

public Supply setStatus(BoundCodeDt<SupplyStatusEnum> theValue)

Sets the value(s) for status (requested | dispensed | received | failed | cancelled)

Definition: Status of the supply request

setStatus

public Supply setStatus(SupplyStatusEnum theValue)

Sets the value(s) for status (requested | dispensed | received | failed | cancelled)

Definition: Status of the supply request

getOrderedItem

public ResourceReferenceDt getOrderedItem()

Gets the value(s) for orderedItem (Medication, Substance, or Device requested to be supplied). creating it if it does not exist. Will not return null.

Definition: The item that is requested to be supplied

setOrderedItem

public Supply setOrderedItem(ResourceReferenceDt theValue)

Sets the value(s) for orderedItem (Medication, Substance, or Device requested to be supplied)

Definition: The item that is requested to be supplied

getPatient

public ResourceReferenceDt getPatient()

Gets the value(s) for patient (Patient for whom the item is supplied). creating it if it does not exist. Will not return null.

Definition: A link to a resource representing the person whom the ordered item is for

setPatient

public Supply setPatient(ResourceReferenceDt theValue)

Sets the value(s) for patient (Patient for whom the item is supplied)

Definition: A link to a resource representing the person whom the ordered item is for

getDispense

public List<Supply.Dispense> getDispense()

Gets the value(s) for dispense (Supply details). creating it if it does not exist. Will not return null.

Definition: Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.

setDispense

public Supply setDispense(List<Supply.Dispense> theValue)

Sets the value(s) for dispense (Supply details)

Definition: Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.

addDispense

public Supply.Dispense addDispense()

Adds and returns a new value for dispense (Supply details)

Definition: Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.

getDispenseFirstRep

public Supply.Dispense getDispenseFirstRep()

Gets the first repetition for dispense (Supply details), creating it if it does not already exist.

Definition: Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.