Package org.hl7.fhir.r5.model

Class RequestOrchestration

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.RequestOrchestration

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 RequestOrchestration
extends DomainResource

A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestOrchestration.RequestOrchestrationActionComponent
static class	RequestOrchestration.RequestOrchestrationActionConditionComponent
static class	RequestOrchestration.RequestOrchestrationActionDynamicValueComponent
static class	RequestOrchestration.RequestOrchestrationActionInputComponent
static class	RequestOrchestration.RequestOrchestrationActionOutputComponent
static class	RequestOrchestration.RequestOrchestrationActionParticipantComponent
static class	RequestOrchestration.RequestOrchestrationActionRelatedActionComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<RequestOrchestration.RequestOrchestrationActionComponent>	action	The actions, if any, produced by the evaluation of the artifact.
protected Reference	author	Provides a reference to the author of the request orchestration.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHOR	Fluent Client search parameter constant for author
static final ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORED	Fluent Client search parameter constant for authored
protected DateTimeType	authoredOn	Indicates when the request orchestration was created.
protected List<Reference>	basedOn	A plan, proposal or order that is fulfilled in whole or in part by this request.
protected CodeableConcept	code	A code that identifies what the overall request orchestration is.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected Reference	encounter	Describes the context of the request orchestration, if any.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected List<Reference>	goal	Goals that are intended to be achieved by following the requests in this RequestOrchestration.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	GROUP_IDENTIFIER	Fluent Client search parameter constant for group-identifier
protected Identifier	groupIdentifier	A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
protected List<Identifier>	identifier	Allows a service to provide a unique, business identifier for the request.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_AUTHOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INSTANTIATES_CANONICAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PARTICIPANT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INSTANTIATES_CANONICAL	Fluent Client search parameter constant for instantiates-canonical
static final ca.uhn.fhir.rest.gclient.UriClientParam	INSTANTIATES_URI	Fluent Client search parameter constant for instantiates-uri
protected List<CanonicalType>	instantiatesCanonical	A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
protected List<UriType>	instantiatesUri	A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
protected Enumeration<Enumerations.RequestIntent>	intent	Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INTENT	Fluent Client search parameter constant for intent
protected List<Annotation>	note	Provides a mechanism to communicate additional information about the response.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PARTICIPANT	Fluent Client search parameter constant for participant
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Enumeration<Enumerations.RequestPriority>	priority	Indicates how quickly the request should be addressed with respect to other requests.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PRIORITY	Fluent Client search parameter constant for priority
protected List<CodeableReference>	reason	Describes the reason for the request orchestration in coded or textual form.
protected List<Reference>	replaces	Completed or terminated request(s) whose function is taken by this new request.
static final String	SP_AUTHOR	Search parameter: author
static final String	SP_AUTHORED	Search parameter: authored
static final String	SP_CODE	Search parameter: code
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_GROUP_IDENTIFIER	Search parameter: group-identifier
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INSTANTIATES_CANONICAL	Search parameter: instantiates-canonical
static final String	SP_INSTANTIATES_URI	Search parameter: instantiates-uri
static final String	SP_INTENT	Search parameter: intent
static final String	SP_PARTICIPANT	Search parameter: participant
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PRIORITY	Search parameter: priority
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<Enumerations.RequestStatus>	status	The current state of the request.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The subject for which the request orchestration was created.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
RequestOrchestration()	Constructor
RequestOrchestration(Enumerations.RequestStatus status, Enumerations.RequestIntent intent)	Constructor

Method Summary

Modifier and Type	Method	Description
RequestOrchestration.RequestOrchestrationActionComponent	addAction()
RequestOrchestration	addAction(RequestOrchestration.RequestOrchestrationActionComponent t)
Reference	addBasedOn()
RequestOrchestration	addBasedOn(Reference t)
Base	addChild(String name)
Reference	addGoal()
RequestOrchestration	addGoal(Reference t)
Identifier	addIdentifier()
RequestOrchestration	addIdentifier(Identifier t)
RequestOrchestration	addInstantiatesCanonical(String value)
CanonicalType	addInstantiatesCanonicalElement()
RequestOrchestration	addInstantiatesUri(String value)
UriType	addInstantiatesUriElement()
Annotation	addNote()
RequestOrchestration	addNote(Annotation t)
CodeableReference	addReason()
RequestOrchestration	addReason(CodeableReference t)
Reference	addReplaces()
RequestOrchestration	addReplaces(Reference t)
RequestOrchestration	copy()
void	copyValues(RequestOrchestration dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<RequestOrchestration.RequestOrchestrationActionComponent>	getAction()
RequestOrchestration.RequestOrchestrationActionComponent	getActionFirstRep()
Reference	getAuthor()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
CodeableConcept	getCode()
Reference	getEncounter()
List<Reference>	getGoal()
Reference	getGoalFirstRep()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CanonicalType>	getInstantiatesCanonical()
List<UriType>	getInstantiatesUri()
Enumerations.RequestIntent	getIntent()
Enumeration<Enumerations.RequestIntent>	getIntentElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Enumerations.RequestPriority	getPriority()
Enumeration<Enumerations.RequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableReference>	getReason()
CodeableReference	getReasonFirstRep()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
ResourceType	getResourceType()
Enumerations.RequestStatus	getStatus()
Enumeration<Enumerations.RequestStatus>	getStatusElement()
Reference	getSubject()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAction()
boolean	hasAuthor()
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasCode()
boolean	hasEncounter()
boolean	hasGoal()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasInstantiatesCanonical()
boolean	hasInstantiatesCanonical(String value)
boolean	hasInstantiatesUri()
boolean	hasInstantiatesUri(String value)
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasNote()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReason()
boolean	hasReplaces()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
RequestOrchestration	setAction(List<RequestOrchestration.RequestOrchestrationActionComponent> theAction)
RequestOrchestration	setAuthor(Reference value)
RequestOrchestration	setAuthoredOn(Date value)
RequestOrchestration	setAuthoredOnElement(DateTimeType value)
RequestOrchestration	setBasedOn(List<Reference> theBasedOn)
RequestOrchestration	setCode(CodeableConcept value)
RequestOrchestration	setEncounter(Reference value)
RequestOrchestration	setGoal(List<Reference> theGoal)
RequestOrchestration	setGroupIdentifier(Identifier value)
RequestOrchestration	setIdentifier(List<Identifier> theIdentifier)
RequestOrchestration	setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
RequestOrchestration	setInstantiatesUri(List<UriType> theInstantiatesUri)
RequestOrchestration	setIntent(Enumerations.RequestIntent value)
RequestOrchestration	setIntentElement(Enumeration<Enumerations.RequestIntent> value)
RequestOrchestration	setNote(List<Annotation> theNote)
RequestOrchestration	setPriority(Enumerations.RequestPriority value)
RequestOrchestration	setPriorityElement(Enumeration<Enumerations.RequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
RequestOrchestration	setReason(List<CodeableReference> theReason)
RequestOrchestration	setReplaces(List<Reference> theReplaces)
RequestOrchestration	setStatus(Enumerations.RequestStatus value)
RequestOrchestration	setStatusElement(Enumeration<Enumerations.RequestStatus> value)
RequestOrchestration	setSubject(Reference value)
protected RequestOrchestration	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, setId

Field Details

identifier

protected List<Identifier> identifier

Allows a service to provide a unique, business identifier for the request.

instantiatesCanonical

protected List<CanonicalType> instantiatesCanonical

A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

instantiatesUri

protected List<UriType> instantiatesUri

A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

basedOn

protected List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this request.

replaces

protected List<Reference> replaces

Completed or terminated request(s) whose function is taken by this new request.

groupIdentifier

protected Identifier groupIdentifier

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

status

protected Enumeration<Enumerations.RequestStatus> status

The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

intent

protected Enumeration<Enumerations.RequestIntent> intent

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

priority

protected Enumeration<Enumerations.RequestPriority> priority

Indicates how quickly the request should be addressed with respect to other requests.

code

protected CodeableConcept code

A code that identifies what the overall request orchestration is.

subject

protected Reference subject

The subject for which the request orchestration was created.

encounter

protected Reference encounter

Describes the context of the request orchestration, if any.

authoredOn

protected DateTimeType authoredOn

Indicates when the request orchestration was created.

author

protected Reference author

Provides a reference to the author of the request orchestration.

reason

protected List<CodeableReference> reason

Describes the reason for the request orchestration in coded or textual form.

goal

protected List<Reference> goal

Goals that are intended to be achieved by following the requests in this RequestOrchestration.

note

protected List<Annotation> note

Provides a mechanism to communicate additional information about the response.

action

protected List<RequestOrchestration.RequestOrchestrationActionComponent> action

The actions, if any, produced by the evaluation of the artifact.

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: The author of the request orchestration
Type: reference
Path: RequestOrchestration.author

See Also:

• Constant Field Values

AUTHOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: The author of the request orchestration
Type: reference
Path: RequestOrchestration.author

INCLUDE_AUTHOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "RequestOrchestration:author".

SP_AUTHORED

public static final String SP_AUTHORED

Search parameter: authored

Description: The date the request orchestration was authored
Type: date
Path: RequestOrchestration.authoredOn

See Also:

• Constant Field Values

AUTHORED

public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED

Fluent Client search parameter constant for authored

Description: The date the request orchestration was authored
Type: date
Path: RequestOrchestration.authoredOn

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: The code of the request orchestration
Type: token
Path: RequestOrchestration.code

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: The code of the request orchestration
Type: token
Path: RequestOrchestration.code

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: The encounter the request orchestration applies to
Type: reference
Path: RequestOrchestration.encounter

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: The encounter the request orchestration applies to
Type: reference
Path: RequestOrchestration.encounter

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "RequestOrchestration:encounter".

SP_GROUP_IDENTIFIER

public static final String SP_GROUP_IDENTIFIER

Search parameter: group-identifier

Description: The group identifier for the request orchestration
Type: token
Path: RequestOrchestration.groupIdentifier

See Also:

• Constant Field Values

GROUP_IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP_IDENTIFIER

Fluent Client search parameter constant for group-identifier

Description: The group identifier for the request orchestration
Type: token
Path: RequestOrchestration.groupIdentifier

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifiers for the request orchestration
Type: token
Path: RequestOrchestration.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: External identifiers for the request orchestration
Type: token
Path: RequestOrchestration.identifier

SP_INSTANTIATES_CANONICAL

public static final String SP_INSTANTIATES_CANONICAL

Search parameter: instantiates-canonical

Description: The FHIR-based definition from which the request orchestration is realized
Type: reference
Path: RequestOrchestration.instantiatesCanonical

See Also:

• Constant Field Values

INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL

Fluent Client search parameter constant for instantiates-canonical

Description: The FHIR-based definition from which the request orchestration is realized
Type: reference
Path: RequestOrchestration.instantiatesCanonical

INCLUDE_INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "RequestOrchestration:instantiates-canonical".

SP_INSTANTIATES_URI

public static final String SP_INSTANTIATES_URI

Search parameter: instantiates-uri

Description: The external definition from which the request orchestration is realized
Type: uri
Path: RequestOrchestration.instantiatesUri

See Also:

• Constant Field Values

INSTANTIATES_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI

Fluent Client search parameter constant for instantiates-uri

Description: The external definition from which the request orchestration is realized
Type: uri
Path: RequestOrchestration.instantiatesUri

SP_INTENT

public static final String SP_INTENT

Search parameter: intent

Description: The intent of the request orchestration
Type: token
Path: RequestOrchestration.intent

See Also:

• Constant Field Values

INTENT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT

Fluent Client search parameter constant for intent

Description: The intent of the request orchestration
Type: token
Path: RequestOrchestration.intent

SP_PARTICIPANT

public static final String SP_PARTICIPANT

Search parameter: participant

Description: The participant in the requests in the orchestration
Type: reference
Path: RequestOrchestration.action.participant.actor.as(Reference) | RequestOrchestration.action.participant.actor.as(canonical)

See Also:

• Constant Field Values

PARTICIPANT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT

Fluent Client search parameter constant for participant

Description: The participant in the requests in the orchestration
Type: reference
Path: RequestOrchestration.action.participant.actor.as(Reference) | RequestOrchestration.action.participant.actor.as(canonical)

INCLUDE_PARTICIPANT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT

Constant for fluent queries to be used to add include statements. Specifies the path value of "RequestOrchestration:participant".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The identity of a patient to search for request orchestrations
Type: reference
Path: RequestOrchestration.subject.where(resolve() is Patient)

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of a patient to search for request orchestrations
Type: reference
Path: RequestOrchestration.subject.where(resolve() is Patient)

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 "RequestOrchestration:patient".

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: The priority of the request orchestration
Type: token
Path: RequestOrchestration.priority

See Also:

• Constant Field Values

PRIORITY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY

Fluent Client search parameter constant for priority

Description: The priority of the request orchestration
Type: token
Path: RequestOrchestration.priority

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the request orchestration
Type: token
Path: RequestOrchestration.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status of the request orchestration
Type: token
Path: RequestOrchestration.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: The subject that the request orchestration is about
Type: reference
Path: RequestOrchestration.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The subject that the request orchestration is about
Type: reference
Path: RequestOrchestration.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 "RequestOrchestration:subject".

Constructor Details

RequestOrchestration

public RequestOrchestration()

Constructor

RequestOrchestration

public RequestOrchestration(Enumerations.RequestStatus status,
 Enumerations.RequestIntent intent)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Allows a service to provide a unique, business identifier for the request.)

setIdentifier

public RequestOrchestration setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public RequestOrchestration addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getInstantiatesCanonical

public List<CanonicalType> getInstantiatesCanonical()

Returns:

instantiatesCanonical (A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

setInstantiatesCanonical

public RequestOrchestration setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical()

addInstantiatesCanonicalElement

public CanonicalType addInstantiatesCanonicalElement()

Returns:

instantiatesCanonical (A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

addInstantiatesCanonical

public RequestOrchestration addInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

getInstantiatesUri

public List<UriType> getInstantiatesUri()

Returns:

instantiatesUri (A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

setInstantiatesUri

public RequestOrchestration setInstantiatesUri(List<UriType> theInstantiatesUri)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesUri

public boolean hasInstantiatesUri()

addInstantiatesUriElement

public UriType addInstantiatesUriElement()

Returns:

instantiatesUri (A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

addInstantiatesUri

public RequestOrchestration addInstantiatesUri(String value)

Parameters:

value - instantiatesUri (A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

hasInstantiatesUri

public boolean hasInstantiatesUri(String value)

Parameters:

value - instantiatesUri (A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (A plan, proposal or order that is fulfilled in whole or in part by this request.)

setBasedOn

public RequestOrchestration setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public RequestOrchestration addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist {3}

getReplaces

public List<Reference> getReplaces()

Returns:

replaces (Completed or terminated request(s) whose function is taken by this new request.)

setReplaces

public RequestOrchestration setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public RequestOrchestration addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

The first repetition of repeating field replaces, creating it if it does not already exist {3}

getGroupIdentifier

public Identifier getGroupIdentifier()

Returns:

groupIdentifier (A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.)

hasGroupIdentifier

public boolean hasGroupIdentifier()

setGroupIdentifier

public RequestOrchestration setGroupIdentifier(Identifier value)

Parameters:

value - groupIdentifier (A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.)

getStatusElement

public Enumeration<Enumerations.RequestStatus> getStatusElement()

Returns:

status (The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public RequestOrchestration setStatusElement(Enumeration<Enumerations.RequestStatus> value)

Parameters:

value - status (The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.RequestStatus getStatus()

Returns:

The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

setStatus

public RequestOrchestration setStatus(Enumerations.RequestStatus value)

Parameters:

value - The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

getIntentElement

public Enumeration<Enumerations.RequestIntent> getIntentElement()

Returns:

intent (Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

hasIntentElement

public boolean hasIntentElement()

hasIntent

public boolean hasIntent()

setIntentElement

public RequestOrchestration setIntentElement(Enumeration<Enumerations.RequestIntent> value)

Parameters:

value - intent (Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

getIntent

public Enumerations.RequestIntent getIntent()

Returns:

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

setIntent

public RequestOrchestration setIntent(Enumerations.RequestIntent value)

Parameters:

value - Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

getPriorityElement

public Enumeration<Enumerations.RequestPriority> getPriorityElement()

Returns:

priority (Indicates how quickly the request should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

hasPriorityElement

public boolean hasPriorityElement()

hasPriority

public boolean hasPriority()

setPriorityElement

public RequestOrchestration setPriorityElement(Enumeration<Enumerations.RequestPriority> value)

Parameters:

value - priority (Indicates how quickly the request should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

getPriority

public Enumerations.RequestPriority getPriority()

Returns:

Indicates how quickly the request should be addressed with respect to other requests.

setPriority

public RequestOrchestration setPriority(Enumerations.RequestPriority value)

Parameters:

value - Indicates how quickly the request should be addressed with respect to other requests.

getCode

public CodeableConcept getCode()

Returns:

code (A code that identifies what the overall request orchestration is.)

hasCode

public boolean hasCode()

setCode

public RequestOrchestration setCode(CodeableConcept value)

Parameters:

value - code (A code that identifies what the overall request orchestration is.)

getSubject

public Reference getSubject()

Returns:

subject (The subject for which the request orchestration was created.)

hasSubject

public boolean hasSubject()

setSubject

public RequestOrchestration setSubject(Reference value)

Parameters:

value - subject (The subject for which the request orchestration was created.)

getEncounter

public Reference getEncounter()

Returns:

encounter (Describes the context of the request orchestration, if any.)

hasEncounter

public boolean hasEncounter()

setEncounter

public RequestOrchestration setEncounter(Reference value)

Parameters:

value - encounter (Describes the context of the request orchestration, if any.)

getAuthoredOnElement

public DateTimeType getAuthoredOnElement()

Returns:

authoredOn (Indicates when the request orchestration was created.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

hasAuthoredOnElement

public boolean hasAuthoredOnElement()

hasAuthoredOn

public boolean hasAuthoredOn()

setAuthoredOnElement

public RequestOrchestration setAuthoredOnElement(DateTimeType value)

Parameters:

value - authoredOn (Indicates when the request orchestration was created.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

getAuthoredOn

public Date getAuthoredOn()

Returns:

Indicates when the request orchestration was created.

setAuthoredOn

public RequestOrchestration setAuthoredOn(Date value)

Parameters:

value - Indicates when the request orchestration was created.

getAuthor

public Reference getAuthor()

Returns:

author (Provides a reference to the author of the request orchestration.)

hasAuthor

public boolean hasAuthor()

setAuthor

public RequestOrchestration setAuthor(Reference value)

Parameters:

value - author (Provides a reference to the author of the request orchestration.)

getReason

public List<CodeableReference> getReason()

Returns:

reason (Describes the reason for the request orchestration in coded or textual form.)

setReason

public RequestOrchestration setReason(List<CodeableReference> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableReference addReason()

addReason

public RequestOrchestration addReason(CodeableReference t)

getReasonFirstRep

public CodeableReference getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist {3}

getGoal

public List<Reference> getGoal()

Returns:

goal (Goals that are intended to be achieved by following the requests in this RequestOrchestration.)

setGoal

public RequestOrchestration setGoal(List<Reference> theGoal)

Returns:

Returns a reference to this for easy method chaining

hasGoal

public boolean hasGoal()

addGoal

public Reference addGoal()

addGoal

public RequestOrchestration addGoal(Reference t)

getGoalFirstRep

public Reference getGoalFirstRep()

Returns:

The first repetition of repeating field goal, creating it if it does not already exist {3}

getNote

public List<Annotation> getNote()

Returns:

note (Provides a mechanism to communicate additional information about the response.)

setNote

public RequestOrchestration setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public RequestOrchestration addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist {3}

getAction

public List<RequestOrchestration.RequestOrchestrationActionComponent> getAction()

Returns:

action (The actions, if any, produced by the evaluation of the artifact.)

setAction

public RequestOrchestration setAction(List<RequestOrchestration.RequestOrchestrationActionComponent> theAction)

Returns:

Returns a reference to this for easy method chaining

hasAction

public boolean hasAction()

addAction

public RequestOrchestration.RequestOrchestrationActionComponent addAction()

addAction

public RequestOrchestration addAction(RequestOrchestration.RequestOrchestrationActionComponent t)

getActionFirstRep

public RequestOrchestration.RequestOrchestrationActionComponent getActionFirstRep()

Returns:

The first repetition of repeating field action, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public RequestOrchestration copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(RequestOrchestration dst)

typedCopy

protected RequestOrchestration 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