Package org.hl7.fhir.dstu3.model

Class RequestGroup

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.RequestGroup

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

A group 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 enum	RequestGroup.ActionCardinalityBehavior
static class	RequestGroup.ActionCardinalityBehaviorEnumFactory
static enum	RequestGroup.ActionConditionKind
static class	RequestGroup.ActionConditionKindEnumFactory
static enum	RequestGroup.ActionGroupingBehavior
static class	RequestGroup.ActionGroupingBehaviorEnumFactory
static enum	RequestGroup.ActionPrecheckBehavior
static class	RequestGroup.ActionPrecheckBehaviorEnumFactory
static enum	RequestGroup.ActionRelationshipType
static class	RequestGroup.ActionRelationshipTypeEnumFactory
static enum	RequestGroup.ActionRequiredBehavior
static class	RequestGroup.ActionRequiredBehaviorEnumFactory
static enum	RequestGroup.ActionSelectionBehavior
static class	RequestGroup.ActionSelectionBehaviorEnumFactory
static class	RequestGroup.RequestGroupActionComponent
static class	RequestGroup.RequestGroupActionConditionComponent
static class	RequestGroup.RequestGroupActionRelatedActionComponent
static enum	RequestGroup.RequestIntent
static class	RequestGroup.RequestIntentEnumFactory
static enum	RequestGroup.RequestPriority
static class	RequestGroup.RequestPriorityEnumFactory
static enum	RequestGroup.RequestStatus
static class	RequestGroup.RequestStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<RequestGroup.RequestGroupActionComponent>	action	The actions, if any, produced by the evaluation of the artifact.
protected Reference	author	Provides a reference to the author of the request group.
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 group was created.
protected Resource	authorTarget	The actual object that is the target of the reference (Provides a reference to the author of the request group.)
protected List<Reference>	basedOn	A plan, proposal or order that is fulfilled in whole or in part by this request.
protected List<Resource>	basedOnTarget	The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this request.)
protected Reference	context	Describes the context of the request group, if any.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
protected Resource	contextTarget	The actual object that is the target of the reference (Describes the context of the request group, if any.)
protected List<Reference>	definition	A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEFINITION	Fluent Client search parameter constant for definition
protected List<Resource>	definitionTarget	The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
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_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEFINITION	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_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.
protected Enumeration<RequestGroup.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<RequestGroup.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 Type	reason	Indicates the reason the request group was created.
protected List<Reference>	replaces	Completed or terminated request(s) whose function is taken by this new request.
protected List<Resource>	replacesTarget	The actual objects that are the target of the reference (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_CONTEXT	Search parameter: context
static final String	SP_DEFINITION	Search parameter: definition
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_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<RequestGroup.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 group was created.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (The subject for which the request group was created.)

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
RequestGroup()	Constructor
RequestGroup(Enumeration<RequestGroup.RequestStatus> status, Enumeration<RequestGroup.RequestIntent> intent)	Constructor

Method Summary

Modifier and Type	Method	Description
RequestGroup.RequestGroupActionComponent	addAction()
RequestGroup	addAction(RequestGroup.RequestGroupActionComponent t)
Reference	addBasedOn()
RequestGroup	addBasedOn(Reference t)
Base	addChild(String name)
Reference	addDefinition()
RequestGroup	addDefinition(Reference t)
Identifier	addIdentifier()
RequestGroup	addIdentifier(Identifier t)
Annotation	addNote()
RequestGroup	addNote(Annotation t)
Reference	addReplaces()
RequestGroup	addReplaces(Reference t)
RequestGroup	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<RequestGroup.RequestGroupActionComponent>	getAction()
RequestGroup.RequestGroupActionComponent	getActionFirstRep()
Reference	getAuthor()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
Resource	getAuthorTarget()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
Reference	getContext()
Resource	getContextTarget()
List<Reference>	getDefinition()
Reference	getDefinitionFirstRep()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
RequestGroup.RequestIntent	getIntent()
Enumeration<RequestGroup.RequestIntent>	getIntentElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
RequestGroup.RequestPriority	getPriority()
Enumeration<RequestGroup.RequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Type	getReason()
CodeableConcept	getReasonCodeableConcept()
Reference	getReasonReference()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
ResourceType	getResourceType()
RequestGroup.RequestStatus	getStatus()
Enumeration<RequestGroup.RequestStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAction()
boolean	hasAuthor()
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasContext()
boolean	hasDefinition()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasNote()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReason()
boolean	hasReasonCodeableConcept()
boolean	hasReasonReference()
boolean	hasReplaces()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
RequestGroup	setAction(List<RequestGroup.RequestGroupActionComponent> theAction)
RequestGroup	setAuthor(Reference value)
RequestGroup	setAuthoredOn(Date value)
RequestGroup	setAuthoredOnElement(DateTimeType value)
RequestGroup	setAuthorTarget(Resource value)
RequestGroup	setBasedOn(List<Reference> theBasedOn)
RequestGroup	setContext(Reference value)
RequestGroup	setContextTarget(Resource value)
RequestGroup	setDefinition(List<Reference> theDefinition)
RequestGroup	setGroupIdentifier(Identifier value)
RequestGroup	setIdentifier(List<Identifier> theIdentifier)
RequestGroup	setIntent(RequestGroup.RequestIntent value)
RequestGroup	setIntentElement(Enumeration<RequestGroup.RequestIntent> value)
RequestGroup	setNote(List<Annotation> theNote)
RequestGroup	setPriority(RequestGroup.RequestPriority value)
RequestGroup	setPriorityElement(Enumeration<RequestGroup.RequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
RequestGroup	setReason(Type value)
RequestGroup	setReplaces(List<Reference> theReplaces)
RequestGroup	setStatus(RequestGroup.RequestStatus value)
RequestGroup	setStatusElement(Enumeration<RequestGroup.RequestStatus> value)
RequestGroup	setSubject(Reference value)
RequestGroup	setSubjectTarget(Resource value)
protected RequestGroup	typedCopy()

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

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

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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

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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

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

definition

protected List<Reference> definition

A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

definitionTarget

protected List<Resource> definitionTarget

The actual objects that are the target of the reference (A 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.

basedOnTarget

protected List<Resource> basedOnTarget

The actual objects that are the target of the reference (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.

replacesTarget

protected List<Resource> replacesTarget

The actual objects that are the target of the reference (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<RequestGroup.RequestStatus> status

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

intent

protected Enumeration<RequestGroup.RequestIntent> intent

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

priority

protected Enumeration<RequestGroup.RequestPriority> priority

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

subject

protected Reference subject

The subject for which the request group was created.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (The subject for which the request group was created.)

context

protected Reference context

Describes the context of the request group, if any.

contextTarget

protected Resource contextTarget

The actual object that is the target of the reference (Describes the context of the request group, if any.)

authoredOn

protected DateTimeType authoredOn

Indicates when the request group was created.

author

protected Reference author

Provides a reference to the author of the request group.

authorTarget

protected Resource authorTarget

The actual object that is the target of the reference (Provides a reference to the author of the request group.)

reason

protected Type reason

Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

note

protected List<Annotation> note

Provides a mechanism to communicate additional information about the response.

action

protected List<RequestGroup.RequestGroupActionComponent> action

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

SP_AUTHORED

public static final String SP_AUTHORED

Search parameter: authored

Description: The date the request group was authored
Type: date
Path: RequestGroup.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 group was authored
Type: date
Path: RequestGroup.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifiers for the request group
Type: token
Path: RequestGroup.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 group
Type: token
Path: RequestGroup.identifier

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

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

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: The author of the request group
Type: reference
Path: RequestGroup.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 group
Type: reference
Path: RequestGroup.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 "RequestGroup:author".

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: The encounter the request group applies to
Type: reference
Path: RequestGroup.context

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 group applies to
Type: reference
Path: RequestGroup.context

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 "RequestGroup:encounter".

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: The priority of the request group
Type: token
Path: RequestGroup.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 group
Type: token
Path: RequestGroup.priority

SP_INTENT

public static final String SP_INTENT

Search parameter: intent

Description: The intent of the request group
Type: token
Path: RequestGroup.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 group
Type: token
Path: RequestGroup.intent

SP_PARTICIPANT

public static final String SP_PARTICIPANT

Search parameter: participant

Description: The participant in the requests in the group
Type: reference
Path: RequestGroup.action.participant

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 group
Type: reference
Path: RequestGroup.action.participant

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 "RequestGroup:participant".

SP_GROUP_IDENTIFIER

public static final String SP_GROUP_IDENTIFIER

Search parameter: group-identifier

Description: The group identifier for the request group
Type: token
Path: RequestGroup.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 group
Type: token
Path: RequestGroup.groupIdentifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The identity of a patient to search for request groups
Type: reference
Path: RequestGroup.subject

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 groups
Type: reference
Path: RequestGroup.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 "RequestGroup:patient".

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: The context the request group applies to
Type: reference
Path: RequestGroup.context

See Also:

• Constant Field Values

CONTEXT

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

Fluent Client search parameter constant for context

Description: The context the request group applies to
Type: reference
Path: RequestGroup.context

INCLUDE_CONTEXT

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

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

SP_DEFINITION

public static final String SP_DEFINITION

Search parameter: definition

Description: The definition from which the request group is realized
Type: reference
Path: RequestGroup.definition

See Also:

• Constant Field Values

DEFINITION

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

Fluent Client search parameter constant for definition

Description: The definition from which the request group is realized
Type: reference
Path: RequestGroup.definition

INCLUDE_DEFINITION

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

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the request group
Type: token
Path: RequestGroup.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 group
Type: token
Path: RequestGroup.status

Constructor Details

RequestGroup

public RequestGroup()

Constructor

RequestGroup

public RequestGroup(Enumeration<RequestGroup.RequestStatus> status,
 Enumeration<RequestGroup.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 RequestGroup setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public RequestGroup addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getDefinition

public List<Reference> getDefinition()

Returns:

definition (A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)

setDefinition

public RequestGroup setDefinition(List<Reference> theDefinition)

Returns:

Returns a reference to this for easy method chaining

hasDefinition

public boolean hasDefinition()

addDefinition

public Reference addDefinition()

addDefinition

public RequestGroup addDefinition(Reference t)

getDefinitionFirstRep

public Reference getDefinitionFirstRep()

Returns:

The first repetition of repeating field definition, creating it if it does not already exist

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 RequestGroup setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public RequestGroup addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

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

getReplaces

public List<Reference> getReplaces()

Returns:

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

setReplaces

public RequestGroup setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public RequestGroup addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

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

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 RequestGroup 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<RequestGroup.RequestStatus> getStatusElement()

Returns:

status (The current state of the request. For request groups, the status reflects the status of all the requests in the group.). 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 RequestGroup setStatusElement(Enumeration<RequestGroup.RequestStatus> value)

Parameters:

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

getStatus

public RequestGroup.RequestStatus getStatus()

Returns:

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

setStatus

public RequestGroup setStatus(RequestGroup.RequestStatus value)

Parameters:

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

getIntentElement

public Enumeration<RequestGroup.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 RequestGroup setIntentElement(Enumeration<RequestGroup.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 RequestGroup.RequestIntent getIntent()

Returns:

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

setIntent

public RequestGroup setIntent(RequestGroup.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<RequestGroup.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 RequestGroup setPriorityElement(Enumeration<RequestGroup.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 RequestGroup.RequestPriority getPriority()

Returns:

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

setPriority

public RequestGroup setPriority(RequestGroup.RequestPriority value)

Parameters:

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

getSubject

public Reference getSubject()

Returns:

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

hasSubject

public boolean hasSubject()

setSubject

public RequestGroup setSubject(Reference value)

Parameters:

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

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. (The subject for which the request group was created.)

setSubjectTarget

public RequestGroup 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. (The subject for which the request group was created.)

getContext

public Reference getContext()

Returns:

context (Describes the context of the request group, if any.)

hasContext

public boolean hasContext()

setContext

public RequestGroup setContext(Reference value)

Parameters:

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

getContextTarget

public Resource getContextTarget()

Returns:

context 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. (Describes the context of the request group, if any.)

setContextTarget

public RequestGroup setContextTarget(Resource value)

Parameters:

value - context 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. (Describes the context of the request group, if any.)

getAuthoredOnElement

public DateTimeType getAuthoredOnElement()

Returns:

authoredOn (Indicates when the request group 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 RequestGroup setAuthoredOnElement(DateTimeType value)

Parameters:

value - authoredOn (Indicates when the request group 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 group was created.

setAuthoredOn

public RequestGroup setAuthoredOn(Date value)

Parameters:

value - Indicates when the request group was created.

getAuthor

public Reference getAuthor()

Returns:

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

hasAuthor

public boolean hasAuthor()

setAuthor

public RequestGroup setAuthor(Reference value)

Parameters:

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

getAuthorTarget

public Resource getAuthorTarget()

Returns:

author 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. (Provides a reference to the author of the request group.)

setAuthorTarget

public RequestGroup setAuthorTarget(Resource value)

Parameters:

value - author 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. (Provides a reference to the author of the request group.)

getReason

public Type getReason()

Returns:

reason (Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)

getReasonCodeableConcept

public CodeableConcept getReasonCodeableConcept()
                                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

reason (Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasReasonCodeableConcept

public boolean hasReasonCodeableConcept()

getReasonReference

public Reference getReasonReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

reason (Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasReasonReference

public boolean hasReasonReference()

hasReason

public boolean hasReason()

setReason

public RequestGroup setReason(Type value)
                       throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - reason (Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getNote

public List<Annotation> getNote()

Returns:

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

setNote

public RequestGroup setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public RequestGroup addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getAction

public List<RequestGroup.RequestGroupActionComponent> getAction()

Returns:

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

setAction

public RequestGroup setAction(List<RequestGroup.RequestGroupActionComponent> theAction)

Returns:

Returns a reference to this for easy method chaining

hasAction

public boolean hasAction()

addAction

public RequestGroup.RequestGroupActionComponent addAction()

addAction

public RequestGroup addAction(RequestGroup.RequestGroupActionComponent t)

getActionFirstRep

public RequestGroup.RequestGroupActionComponent getActionFirstRep()

Returns:

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

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 RequestGroup copy()

Specified by:

copy in class DomainResource

typedCopy

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