Order (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.Order

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Order
extends BaseResource
implements IResource
```
HAPI/FHIR Order Resource (A request to perform an action)
Definition:

Requirements:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.When
Block class for child element: Order.when (When order should be fulfilled)

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.When` Block class for child element: Order.when (When order should be fulfilled)

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHORITY` Fluent Client search parameter constant for authority
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ReferenceClientParam`	`DETAIL` Fluent Client search parameter constant for detail
`static Include`	`INCLUDE_AUTHORITY` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_DETAIL` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SOURCE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_TARGET` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_AUTHORITY` Search parameter constant for authority
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DETAIL` Search parameter constant for detail
`static String`	`SP_SOURCE` Search parameter constant for source
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_TARGET` Search parameter constant for target
`static String`	`SP_WHEN` Search parameter constant for when
`static String`	`SP_WHEN_CODE` Search parameter constant for when_code
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static ReferenceClientParam`	`TARGET` Fluent Client search parameter constant for target
`static DateClientParam`	`WHEN` Fluent Client search parameter constant for when
`static TokenClientParam`	`WHEN_CODE` Fluent Client search parameter constant for when_code

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

Constructor Summary

Constructors
Constructor and Description

Order()

Constructors
Constructor and Description
`Order()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addDetail()` Adds and returns a new value for detail (What action is being ordered)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`Order`	`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)
`Order`	`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
`ResourceReferenceDt`	`getAuthority()` Gets the value(s) for authority (If required by policy).
`DateTimeDt`	`getDate()` Gets the value(s) for date (When the order was made).
`List<ResourceReferenceDt>`	`getDetail()` Gets the value(s) for detail (What action is being ordered).
`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.
`IDatatype`	`getReason()` Gets the value(s) for reason[x] (Text - why the order was made).
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source (Who initiated the order).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (Patient this order is about).
`ResourceReferenceDt`	`getTarget()` Gets the value(s) for target (Who is intended to fulfill the order).
`Order.When`	`getWhen()` Gets the value(s) for when (When order should be fulfilled).
`boolean`	`isEmpty()`
`Order`	`setAuthority(ResourceReferenceDt theValue)` Sets the value(s) for authority (If required by policy)
`Order`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (When the order was made)
`Order`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (When the order was made)
`Order`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (When the order was made)
`Order`	`setDetail(List<ResourceReferenceDt> theValue)` Sets the value(s) for detail (What action is being ordered)
`Order`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Identifiers assigned to this order by the orderer or by the receiver)
`Order`	`setReason(IDatatype theValue)` Sets the value(s) for reason[x] (Text - why the order was made)
`Order`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source (Who initiated the order)
`Order`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (Patient this order is about)
`Order`	`setTarget(ResourceReferenceDt theValue)` Sets the value(s) for target (Who is intended to fulfill the order)
`Order`	`setWhen(Order.When theValue)` Sets the value(s) for when (When order should be fulfilled)

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_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: Order.date
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: Order.date
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description:
    Type: reference
    Path: Order.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description:
    Type: reference
    Path: Order.subject
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order.subject".
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: reference
    Path: Order.source
    
    See Also:
    Constant Field Values
  - SOURCE
```
public static final ReferenceClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: reference
    Path: Order.source
  - INCLUDE_SOURCE
```
public static final Include INCLUDE_SOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order.source".
  - SP_TARGET
```
public static final String SP_TARGET
```
    Search parameter constant for target
    Description:
    Type: reference
    Path: Order.target
    
    See Also:
    Constant Field Values
  - TARGET
```
public static final ReferenceClientParam TARGET
```
    Fluent Client search parameter constant for target
    Description:
    Type: reference
    Path: Order.target
  - INCLUDE_TARGET
```
public static final Include INCLUDE_TARGET
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order.target".
  - SP_AUTHORITY
```
public static final String SP_AUTHORITY
```
    Search parameter constant for authority
    Description:
    Type: reference
    Path: Order.authority
    
    See Also:
    Constant Field Values
  - AUTHORITY
```
public static final ReferenceClientParam AUTHORITY
```
    Fluent Client search parameter constant for authority
    Description:
    Type: reference
    Path: Order.authority
  - INCLUDE_AUTHORITY
```
public static final Include INCLUDE_AUTHORITY
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order.authority".
  - SP_WHEN_CODE
```
public static final String SP_WHEN_CODE
```
    Search parameter constant for when_code
    Description:
    Type: token
    Path: Order.when.code
    
    See Also:
    Constant Field Values
  - WHEN_CODE
```
public static final TokenClientParam WHEN_CODE
```
    Fluent Client search parameter constant for when_code
    Description:
    Type: token
    Path: Order.when.code
  - SP_WHEN
```
public static final String SP_WHEN
```
    Search parameter constant for when
    Description:
    Type: date
    Path: Order.when.schedule
    
    See Also:
    Constant Field Values
  - WHEN
```
public static final DateClientParam WHEN
```
    Fluent Client search parameter constant for when
    Description:
    Type: date
    Path: Order.when.schedule
  - SP_DETAIL
```
public static final String SP_DETAIL
```
    Search parameter constant for detail
    Description:
    Type: reference
    Path: Order.detail
    
    See Also:
    Constant Field Values
  - DETAIL
```
public static final ReferenceClientParam DETAIL
```
    Fluent Client search parameter constant for detail
    Description:
    Type: reference
    Path: Order.detail
  - INCLUDE_DETAIL
```
public static final Include INCLUDE_DETAIL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order.detail".
- Constructor Detail
  - Order
```
public Order()
```
- 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:
  - setIdentifier
```
public Order setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (Identifiers assigned to this order by the orderer or by the receiver)
    Definition:
  - 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:
  - 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:
  - addIdentifier
```
public Order 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:
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Order addIdentifier(String theSystem,
                  String theValue)
```
    Adds a new value for identifier (Identifiers assigned to this order by the orderer or by the receiver)
    Definition:
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getDate
```
public DateTimeDt getDate()
```
    Gets the value(s) for date (When the order was made). creating it if it does not exist. Will not return null.
    Definition:
  - setDate
```
public Order setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (When the order was made)
    Definition:
  - setDateWithSecondsPrecision
```
public Order setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (When the order was made)
    Definition:
  - setDate
```
public Order setDate(Date theDate,
            TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (When the order was made)
    Definition:
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (Patient this order is about). creating it if it does not exist. Will not return null.
    Definition:
  - setSubject
```
public Order setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (Patient this order is about)
    Definition:
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (Who initiated the order). creating it if it does not exist. Will not return null.
    Definition:
  - setSource
```
public Order setSource(ResourceReferenceDt theValue)
```
    Sets the value(s) for source (Who initiated the order)
    Definition:
  - getTarget
```
public ResourceReferenceDt getTarget()
```
    Gets the value(s) for target (Who is intended to fulfill the order). creating it if it does not exist. Will not return null.
    Definition:
  - setTarget
```
public Order setTarget(ResourceReferenceDt theValue)
```
    Sets the value(s) for target (Who is intended to fulfill the order)
    Definition:
  - getReason
```
public IDatatype getReason()
```
    Gets the value(s) for reason[x] (Text - why the order was made). creating it if it does not exist. Will not return null.
    Definition:
  - setReason
```
public Order setReason(IDatatype theValue)
```
    Sets the value(s) for reason[x] (Text - why the order was made)
    Definition:
  - getAuthority
```
public ResourceReferenceDt getAuthority()
```
    Gets the value(s) for authority (If required by policy). creating it if it does not exist. Will not return null.
    Definition:
  - setAuthority
```
public Order setAuthority(ResourceReferenceDt theValue)
```
    Sets the value(s) for authority (If required by policy)
    Definition:
  - getWhen
```
public Order.When getWhen()
```
    Gets the value(s) for when (When order should be fulfilled). creating it if it does not exist. Will not return null.
    Definition:
  - setWhen
```
public Order setWhen(Order.When theValue)
```
    Sets the value(s) for when (When order should be fulfilled)
    Definition:
  - getDetail
```
public List<ResourceReferenceDt> getDetail()
```
    Gets the value(s) for detail (What action is being ordered). creating it if it does not exist. Will not return null.
    Definition:
  - setDetail
```
public Order setDetail(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for detail (What action is being ordered)
    Definition:
  - addDetail
```
public ResourceReferenceDt addDetail()
```
    Adds and returns a new value for detail (What action is being ordered)
    Definition:

Class Order

Nested Class Summary

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_DATE

DATE

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_SOURCE

SOURCE

INCLUDE_SOURCE

SP_TARGET

TARGET

INCLUDE_TARGET

SP_AUTHORITY

AUTHORITY

INCLUDE_AUTHORITY

SP_WHEN_CODE

WHEN_CODE

SP_WHEN

WHEN

SP_DETAIL

DETAIL

INCLUDE_DETAIL

Constructor Detail

Order

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getDate

setDate

setDateWithSecondsPrecision

setDate

getSubject

setSubject

getSource

setSource

getTarget

setTarget

getReason

setReason

getAuthority

setAuthority

getWhen

setWhen

getDetail

setDetail

addDetail