Order (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Order

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 Order
extends DomainResource
```
A request to perform an action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.OrderWhenComponent

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.OrderWhenComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DateTimeType`	`date` When the order was made.
`protected List<Reference>`	`detail` What action is being ordered.
`protected List<Resource>`	`detailTarget` The actual objects that are the target of the reference (What action is being ordered.)
`protected List<Identifier>`	`identifier` Identifiers assigned to this order by the orderer or by the receiver.
`protected Type`	`reason` Text - why the order was made.
`protected Reference`	`source` Who initiated the order.
`protected Resource`	`sourceTarget` The actual object that is the target of the reference (Who initiated the order.)
`static String`	`SP_DATE`
`static String`	`SP_DETAIL`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_SOURCE`
`static String`	`SP_SUBJECT`
`static String`	`SP_TARGET`
`static String`	`SP_WHEN`
`static String`	`SP_WHENCODE`
`protected Reference`	`subject` Patient this order is about.
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Patient this order is about.)
`protected Reference`	`target` Who is intended to fulfill the order.
`protected Resource`	`targetTarget` The actual object that is the target of the reference (Who is intended to fulfill the order.)
`protected Order.OrderWhenComponent`	`when` When order should be fulfilled.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.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

Order()

Constructors
Constructor and Description
`Order()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Reference`	`addDetail()`
`Order`	`addDetail(Reference t)`
`Identifier`	`addIdentifier()`
`Order`	`addIdentifier(Identifier t)`
`Order`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`List<Reference>`	`getDetail()`
`List<Resource>`	`getDetailTarget()`
`List<Identifier>`	`getIdentifier()`
`Type`	`getReason()`
`CodeableConcept`	`getReasonCodeableConcept()`
`Reference`	`getReasonReference()`
`ResourceType`	`getResourceType()`
`Reference`	`getSource()`
`Resource`	`getSourceTarget()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`Reference`	`getTarget()`
`Resource`	`getTargetTarget()`
`Order.OrderWhenComponent`	`getWhen()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDetail()`
`boolean`	`hasIdentifier()`
`boolean`	`hasReason()`
`boolean`	`hasReasonCodeableConcept()`
`boolean`	`hasReasonReference()`
`boolean`	`hasSource()`
`boolean`	`hasSubject()`
`boolean`	`hasTarget()`
`boolean`	`hasWhen()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Order`	`setDate(Date value)`
`Order`	`setDateElement(DateTimeType value)`
`void`	`setProperty(String name, Base value)`
`Order`	`setReason(Type value)`
`Order`	`setSource(Reference value)`
`Order`	`setSourceTarget(Resource value)`
`Order`	`setSubject(Reference value)`
`Order`	`setSubjectTarget(Resource value)`
`Order`	`setTarget(Reference value)`
`Order`	`setTargetTarget(Resource value)`
`Order`	`setWhen(Order.OrderWhenComponent value)`
`protected Order`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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 by the orderer or by the receiver.
  - date
```
protected DateTimeType date
```
    When the order was made.
  - subject
```
protected Reference subject
```
    Patient this order is about.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (Patient this order is about.)
  - source
```
protected Reference source
```
    Who initiated the order.
  - sourceTarget
```
protected Resource sourceTarget
```
    The actual object that is the target of the reference (Who initiated the order.)
  - target
```
protected Reference target
```
    Who is intended to fulfill the order.
  - targetTarget
```
protected Resource targetTarget
```
    The actual object that is the target of the reference (Who is intended to fulfill the order.)
  - reason
```
protected Type reason
```
    Text - why the order was made.
  - when
```
protected Order.OrderWhenComponent when
```
    When order should be fulfilled.
  - detail
```
protected List<Reference> detail
```
    What action is being ordered.
  - detailTarget
```
protected List<Resource> detailTarget
```
    The actual objects that are the target of the reference (What action is being ordered.)
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    See Also:
    
    Constant Field Values
  - SP_DETAIL
```
public static final String SP_DETAIL
```
    See Also:
    
    Constant Field Values
  - SP_WHEN
```
public static final String SP_WHEN
```
    See Also:
    
    Constant Field Values
  - SP_TARGET
```
public static final String SP_TARGET
```
    See Also:
    
    Constant Field Values
  - SP_WHENCODE
```
public static final String SP_WHENCODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Order
```
public Order()
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifiers assigned to this order by the orderer or by the receiver.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Identifiers assigned to this order by the orderer or by the receiver.)
  - addIdentifier
```
public Order addIdentifier(Identifier t)
```
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (When the order was made.). 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 Order setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (When the order was made.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    When the order was made.
  - setDate
```
public Order setDate(Date value)
```
    Parameters:
    
    value - When the order was made.
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Patient this order is about.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Order setSubject(Reference value)
```
    Parameters:
    
    value - subject (Patient this order is about.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject 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. (Patient this order is about.)
  - setSubjectTarget
```
public Order setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject 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. (Patient this order is about.)
  - getSource
```
public Reference getSource()
```
    Returns:
    
    source (Who initiated the order.)
  - hasSource
```
public boolean hasSource()
```
  - setSource
```
public Order setSource(Reference value)
```
    Parameters:
    
    value - source (Who initiated the order.)
  - getSourceTarget
```
public Resource getSourceTarget()
```
    Returns:
    
    source 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. (Who initiated the order.)
  - setSourceTarget
```
public Order setSourceTarget(Resource value)
```
    Parameters:
    
    value - source 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. (Who initiated the order.)
  - getTarget
```
public Reference getTarget()
```
    Returns:
    
    target (Who is intended to fulfill the order.)
  - hasTarget
```
public boolean hasTarget()
```
  - setTarget
```
public Order setTarget(Reference value)
```
    Parameters:
    
    value - target (Who is intended to fulfill the order.)
  - getTargetTarget
```
public Resource getTargetTarget()
```
    Returns:
    
    target 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. (Who is intended to fulfill the order.)
  - setTargetTarget
```
public Order setTargetTarget(Resource value)
```
    Parameters:
    
    value - target 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. (Who is intended to fulfill the order.)
  - getReason
```
public Type getReason()
```
    Returns:
    
    reason (Text - why the order was made.)
  - getReasonCodeableConcept
```
public CodeableConcept getReasonCodeableConcept()
                                         throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (Text - why the order was made.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonCodeableConcept
```
public boolean hasReasonCodeableConcept()
```
  - getReasonReference
```
public Reference getReasonReference()
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (Text - why the order was made.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - hasReason
```
public boolean hasReason()
```
  - setReason
```
public Order setReason(Type value)
```
    Parameters:
    
    value - reason (Text - why the order was made.)
  - getWhen
```
public Order.OrderWhenComponent getWhen()
```
    Returns:
    
    when (When order should be fulfilled.)
  - hasWhen
```
public boolean hasWhen()
```
  - setWhen
```
public Order setWhen(Order.OrderWhenComponent value)
```
    Parameters:
    
    value - when (When order should be fulfilled.)
  - getDetail
```
public List<Reference> getDetail()
```
    Returns:
    
    detail (What action is being ordered.)
  - hasDetail
```
public boolean hasDetail()
```
  - addDetail
```
public Reference addDetail()
```
    Returns:
    
    detail (What action is being ordered.)
  - addDetail
```
public Order addDetail(Reference t)
```
  - getDetailTarget
```
public List<Resource> getDetailTarget()
```
    Returns:
    
    detail (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. What action is being ordered.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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
  - 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 Order copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Order 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

Class Order

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

date

subject

subjectTarget

source

sourceTarget

target

targetTarget

reason

when

detail

detailTarget

SP_DATE

SP_IDENTIFIER

SP_SUBJECT

SP_PATIENT

SP_SOURCE

SP_DETAIL

SP_WHEN

SP_TARGET

SP_WHENCODE

Constructor Detail

Order

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getDateElement

hasDateElement

hasDate

setDateElement

getDate

setDate

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getSource

hasSource

setSource

getSourceTarget

setSourceTarget

getTarget

hasTarget

setTarget

getTargetTarget

setTargetTarget

getReason

getReasonCodeableConcept

hasReasonCodeableConcept

getReasonReference

hasReasonReference

hasReason

setReason

getWhen

hasWhen

setWhen

getDetail

hasDetail

addDetail