Order (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Order

All Implemented Interfaces:

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

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.When
Block class for child element: Order.when ()

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

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ReferenceClientParam`	`DETAIL` Fluent Client search parameter constant for detail
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_DETAIL` 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 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`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DETAIL` Search parameter constant for detail
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PATIENT` Search parameter constant for patient
`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.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

Order()

Constructors
Constructor and Description
`Order()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addDetail()` Adds and returns a new value for detail ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Order`	`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.done).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.done).
`List<ResourceReferenceDt>`	`getDetail()` Gets the value(s) for detail ().
`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.
`IDatatype`	`getReason()` Gets the value(s) for reason[x] (why).
`String`	`getResourceName()`
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source (who.cause).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (who.focus).
`ResourceReferenceDt`	`getTarget()` Gets the value(s) for target (who.actor).
`Order.When`	`getWhen()` Gets the value(s) for when ().
`boolean`	`isEmpty()`
`Order`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.done)
`Order`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.done)
`Order`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.done)
`Order`	`setDetail(List<ResourceReferenceDt> theValue)` Sets the value(s) for detail ()
`Order`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Order`	`setReason(IDatatype theValue)` Sets the value(s) for reason[x] (why)
`Order`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source (who.cause)
`Order`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (who.focus)
`Order`	`setTarget(ResourceReferenceDt theValue)` Sets the value(s) for target (who.actor)
`Order`	`setWhen(Order.When theValue)` Sets the value(s) for when ()

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_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
  - 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
  - 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
  - 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
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: Order.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: Order.subject
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: Instance id from source, target, and/or others
    Type: token
    Path: Order.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Instance id from source, target, and/or others
    Type: token
    Path: Order.identifier
  - 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".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:patient".
  - 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".
  - 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".
  - 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".
- Constructor Detail
  - Order
```
public Order()
```
- 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:
  - setIdentifier
```
public Order setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition:
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition:
  - addIdentifier
```
public Order addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition:
    
    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:
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (when.done). creating it if it does not exist. Will not return null.
    Definition:
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (when.done). 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.done)
    Definition:
  - setDate
```
public Order setDate(Date theDate,
                     TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (when.done)
    Definition:
  - setDateWithSecondsPrecision
```
public Order setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (when.done)
    Definition:
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.
    Definition:
  - setSubject
```
public Order setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (who.focus)
    Definition:
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (who.cause). 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.cause)
    Definition:
  - getTarget
```
public ResourceReferenceDt getTarget()
```
    Gets the value(s) for target (who.actor). 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.actor)
    Definition:
  - getReason
```
public IDatatype getReason()
```
    Gets the value(s) for reason[x] (why). 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] (why)
    Definition:
  - getWhen
```
public Order.When getWhen()
```
    Gets the value(s) for when (). 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 ()
    Definition:
  - getDetail
```
public List<ResourceReferenceDt> getDetail()
```
    Gets the value(s) for detail (). 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 ()
    Definition:
  - addDetail
```
public ResourceReferenceDt addDetail()
```
    Adds and returns a new value for detail ()
    Definition:
  - 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

Class Order

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.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

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

Field Detail

SP_DATE

DATE

SP_SUBJECT

SUBJECT

SP_SOURCE

SOURCE

SP_TARGET

TARGET

SP_WHEN_CODE

WHEN_CODE

SP_WHEN

WHEN

SP_DETAIL

DETAIL

SP_PATIENT

PATIENT

SP_IDENTIFIER

IDENTIFIER

INCLUDE_DETAIL

INCLUDE_PATIENT

INCLUDE_SOURCE

INCLUDE_SUBJECT

INCLUDE_TARGET

Constructor Detail

Order

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getSubject

setSubject

getSource

setSource

getTarget

setTarget

getReason

setReason

getWhen

setWhen

getDetail

setDetail

addDetail

getResourceName

getStructureFhirVersionEnum