Class 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 Description static classOrder.OrderWhenComponent
-
Field Summary
Fields Modifier and Type Field Description protected DateTimeTypedateWhen the order was made.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Reference>detailWhat action is being ordered.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDETAILFluent Client search parameter constant for detailprotected List<Resource>detailTargetThe actual objects that are the target of the reference (What action is being ordered.)protected List<Identifier>identifierIdentifiers assigned to this order by the orderer or by the receiver.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_DETAILConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SOURCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_TARGETConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected TypereasonText - why the order was made.protected ReferencesourceWho initiated the order.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSOURCEFluent Client search parameter constant for sourceprotected ResourcesourceTargetThe actual object that is the target of the reference (Who initiated the order.)static StringSP_DATESearch parameter: datestatic StringSP_DETAILSearch parameter: detailstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SOURCESearch parameter: sourcestatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TARGETSearch parameter: targetstatic StringSP_WHENSearch parameter: whenstatic StringSP_WHENCODESearch parameter: when_codeprotected ReferencesubjectPatient this order is about.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (Patient this order is about.)protected ReferencetargetWho is intended to fulfill the order.static ca.uhn.fhir.rest.gclient.ReferenceClientParamTARGETFluent Client search parameter constant for targetprotected ResourcetargetTargetThe actual object that is the target of the reference (Who is intended to fulfill the order.)protected Order.OrderWhenComponentwhenWhen order should be fulfilled.static ca.uhn.fhir.rest.gclient.DateClientParamWHENFluent Client search parameter constant for whenstatic ca.uhn.fhir.rest.gclient.TokenClientParamWHENCODEFluent Client search parameter constant for when_code-
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
-
-
Constructor Summary
Constructors Constructor Description Order()Constructor
-
Method Summary
-
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
-
-
-
-
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.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (Patient this order is about.)
-
sourceTarget
protected Resource sourceTarget
The actual object that is the target of the reference (Who initiated the order.)
-
targetTarget
protected Resource targetTarget
The actual object that is the target of the reference (Who is intended to fulfill the order.)
-
when
protected Order.OrderWhenComponent when
When order should be fulfilled.
-
detailTarget
protected List<Resource> detailTarget
The actual objects that are the target of the reference (What action is being ordered.)
-
SP_DETAIL
public static final String SP_DETAIL
Search parameter: detailDescription: What action is being ordered
Type: reference
Path: Order.detail
- See Also:
- Constant Field Values
-
DETAIL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DETAIL
Fluent Client search parameter constant for detailDescription: What action is being ordered
Type: reference
Path: Order.detail
-
INCLUDE_DETAIL
public static final ca.uhn.fhir.model.api.Include INCLUDE_DETAIL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:detail".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Patient this order is about
Type: reference
Path: Order.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Patient this order is about
Type: reference
Path: Order.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:patient".
-
SP_SOURCE
public static final String SP_SOURCE
Search parameter: sourceDescription: Who initiated the order
Type: reference
Path: Order.source
- See Also:
- Constant Field Values
-
SOURCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
Fluent Client search parameter constant for sourceDescription: Who initiated the order
Type: reference
Path: Order.source
-
INCLUDE_SOURCE
public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:source".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: Patient this order is about
Type: reference
Path: Order.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: Patient this order is about
Type: reference
Path: Order.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:subject".
-
SP_WHEN
public static final String SP_WHEN
Search parameter: whenDescription: A formal schedule
Type: date
Path: Order.when.schedule
- See Also:
- Constant Field Values
-
WHEN
public static final ca.uhn.fhir.rest.gclient.DateClientParam WHEN
Fluent Client search parameter constant for whenDescription: A formal schedule
Type: date
Path: Order.when.schedule
-
SP_TARGET
public static final String SP_TARGET
Search parameter: targetDescription: Who is intended to fulfill the order
Type: reference
Path: Order.target
- See Also:
- Constant Field Values
-
TARGET
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
Fluent Client search parameter constant for targetDescription: Who is intended to fulfill the order
Type: reference
Path: Order.target
-
INCLUDE_TARGET
public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET
Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:target".
-
SP_WHENCODE
public static final String SP_WHENCODE
Search parameter: when_codeDescription: Code specifies when request should be done. The code may simply be a priority code
Type: token
Path: Order.when.code
- See Also:
- Constant Field Values
-
WHENCODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam WHENCODE
Fluent Client search parameter constant for when_codeDescription: Code specifies when request should be done. The code may simply be a priority code
Type: token
Path: Order.when.code
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: When the order was made
Type: date
Path: Order.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: When the order was made
Type: date
Path: Order.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Instance id from source, target, and/or others
Type: token
Path: Order.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Instance id from source, target, and/or others
Type: token
Path: Order.identifier
-
-
Constructor Detail
-
Order
public Order()
Constructor
-
-
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
-
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:
subjectThe 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-subjectThe 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.)
-
hasSource
public boolean hasSource()
-
setSource
public Order setSource(Reference value)
- Parameters:
value-source(Who initiated the order.)
-
getSourceTarget
public Resource getSourceTarget()
- Returns:
sourceThe 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-sourceThe 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.)
-
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:
targetThe 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-targetThe 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.)
-
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.)
-
hasDetail
public boolean hasDetail()
-
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:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Order copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-