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

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class ProcessRequest
extends BaseResource
implements IResource
```
HAPI/FHIR ProcessRequest Resource ()
Definition: This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcessRequest.Item
Block class for child element: ProcessRequest.item ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessRequest.Item` Block class for child element: ProcessRequest.item ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTION` Fluent Client search parameter constant for action
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_ORGANIZATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PROVIDER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`ORGANIZATION` Fluent Client search parameter constant for organization
`static ReferenceClientParam`	`PROVIDER` Fluent Client search parameter constant for provider
`static String`	`SP_ACTION` Search parameter constant for action
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_ORGANIZATION` Search parameter constant for organization
`static String`	`SP_PROVIDER` Search parameter constant for provider

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor and Description

ProcessRequest()

Constructors
Constructor and Description
`ProcessRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringDt`	`addExclude()` Adds and returns a new value for exclude ()
`ProcessRequest`	`addExclude(String theString)` Adds a new value for exclude ()
`ProcessRequest`	`addExclude(StringDt theValue)` Adds a given new value for exclude ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`ProcessRequest`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`StringDt`	`addInclude()` Adds and returns a new value for include ()
`ProcessRequest`	`addInclude(String theString)` Adds a new value for include ()
`ProcessRequest`	`addInclude(StringDt theValue)` Adds a given new value for include ()
`ProcessRequest.Item`	`addItem()` Adds and returns a new value for item ()
`ProcessRequest`	`addItem(ProcessRequest.Item theValue)` Adds a given new value for item ()
`String`	`getAction()` Gets the value(s) for action ().
`BoundCodeDt<ActionListEnum>`	`getActionElement()` Gets the value(s) for action ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getCreated()` Gets the value(s) for created ().
`DateTimeDt`	`getCreatedElement()` Gets the value(s) for created ().
`List<StringDt>`	`getExclude()` Gets the value(s) for exclude ().
`StringDt`	`getExcludeFirstRep()` Gets the first repetition for exclude (), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`List<StringDt>`	`getInclude()` Gets the value(s) for include ().
`StringDt`	`getIncludeFirstRep()` Gets the first repetition for include (), creating it if it does not already exist.
`List<ProcessRequest.Item>`	`getItem()` Gets the value(s) for item ().
`ProcessRequest.Item`	`getItemFirstRep()` Gets the first repetition for item (), creating it if it does not already exist.
`Boolean`	`getNullify()` Gets the value(s) for nullify ().
`BooleanDt`	`getNullifyElement()` Gets the value(s) for nullify ().
`ResourceReferenceDt`	`getOrganization()` Gets the value(s) for organization ().
`CodingDt`	`getOriginalRuleset()` Gets the value(s) for originalRuleset ().
`PeriodDt`	`getPeriod()` Gets the value(s) for period ().
`ResourceReferenceDt`	`getProvider()` Gets the value(s) for provider ().
`String`	`getReference()` Gets the value(s) for reference ().
`StringDt`	`getReferenceElement()` Gets the value(s) for reference ().
`ResourceReferenceDt`	`getRequest()` Gets the value(s) for request ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getResponse()` Gets the value(s) for response ().
`CodingDt`	`getRuleset()` Gets the value(s) for ruleset ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getTarget()` Gets the value(s) for target ().
`boolean`	`isEmpty()`
`ProcessRequest`	`setAction(ActionListEnum theValue)` Sets the value(s) for action ()
`ProcessRequest`	`setAction(BoundCodeDt<ActionListEnum> theValue)` Sets the value(s) for action ()
`ProcessRequest`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created ()
`ProcessRequest`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created ()
`ProcessRequest`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created ()
`ProcessRequest`	`setExclude(List<StringDt> theValue)` Sets the value(s) for exclude ()
`ProcessRequest`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`ProcessRequest`	`setInclude(List<StringDt> theValue)` Sets the value(s) for include ()
`ProcessRequest`	`setItem(List<ProcessRequest.Item> theValue)` Sets the value(s) for item ()
`ProcessRequest`	`setNullify(boolean theBoolean)` Sets the value for nullify ()
`ProcessRequest`	`setNullify(BooleanDt theValue)` Sets the value(s) for nullify ()
`ProcessRequest`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`ProcessRequest`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`ProcessRequest`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period ()
`ProcessRequest`	`setProvider(ResourceReferenceDt theValue)` Sets the value(s) for provider ()
`ProcessRequest`	`setReference(String theString)` Sets the value for reference ()
`ProcessRequest`	`setReference(StringDt theValue)` Sets the value(s) for reference ()
`ProcessRequest`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`ProcessRequest`	`setResponse(ResourceReferenceDt theValue)` Sets the value(s) for response ()
`ProcessRequest`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()
`ProcessRequest`	`setTarget(ResourceReferenceDt theValue)` Sets the value(s) for target ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The business identifier of the ProcessRequest
    Type: token
    Path: ProcessRequest.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The business identifier of the ProcessRequest
    Type: token
    Path: ProcessRequest.identifier
  - SP_ORGANIZATION
```
public static final String SP_ORGANIZATION
```
    Search parameter constant for organization
    Description: The organization who generated this request
    Type: reference
    Path: ProcessRequest.organization
    
    See Also:
    
    Constant Field Values
  - ORGANIZATION
```
public static final ReferenceClientParam ORGANIZATION
```
    Fluent Client search parameter constant for organization
    Description: The organization who generated this request
    Type: reference
    Path: ProcessRequest.organization
  - SP_PROVIDER
```
public static final String SP_PROVIDER
```
    Search parameter constant for provider
    Description: The provider who regenerated this request
    Type: reference
    Path: ProcessRequest.provider
    
    See Also:
    
    Constant Field Values
  - PROVIDER
```
public static final ReferenceClientParam PROVIDER
```
    Fluent Client search parameter constant for provider
    Description: The provider who regenerated this request
    Type: reference
    Path: ProcessRequest.provider
  - SP_ACTION
```
public static final String SP_ACTION
```
    Search parameter constant for action
    Description: The action requested by this resource
    Type: token
    Path: ProcessRequest.action
    
    See Also:
    
    Constant Field Values
  - ACTION
```
public static final TokenClientParam ACTION
```
    Fluent Client search parameter constant for action
    Description: The action requested by this resource
    Type: token
    Path: ProcessRequest.action
  - INCLUDE_ORGANIZATION
```
public static final Include INCLUDE_ORGANIZATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessRequest:organization".
  - INCLUDE_PROVIDER
```
public static final Include INCLUDE_PROVIDER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessRequest:provider".
- Constructor Detail
  - ProcessRequest
```
public ProcessRequest()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getActionElement
```
public BoundCodeDt<ActionListEnum> getActionElement()
```
    Gets the value(s) for action (). creating it if it does not exist. Will not return null.
    Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest
  - getAction
```
public String getAction()
```
    Gets the value(s) for action (). creating it if it does not exist. Will not return null.
    Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest
  - setAction
```
public ProcessRequest setAction(BoundCodeDt<ActionListEnum> theValue)
```
    Sets the value(s) for action ()
    Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest
  - setAction
```
public ProcessRequest setAction(ActionListEnum theValue)
```
    Sets the value(s) for action ()
    Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: The ProcessRequest business identifier
  - setIdentifier
```
public ProcessRequest setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: The ProcessRequest business identifier
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: The ProcessRequest business identifier
  - addIdentifier
```
public ProcessRequest addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: The ProcessRequest business identifier
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: The ProcessRequest business identifier
  - getRuleset
```
public CodingDt getRuleset()
```
    Gets the value(s) for ruleset (). creating it if it does not exist. Will not return null.
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - setRuleset
```
public ProcessRequest setRuleset(CodingDt theValue)
```
    Sets the value(s) for ruleset ()
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - getOriginalRuleset
```
public CodingDt getOriginalRuleset()
```
    Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - setOriginalRuleset
```
public ProcessRequest setOriginalRuleset(CodingDt theValue)
```
    Sets the value(s) for originalRuleset ()
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - getCreatedElement
```
public DateTimeDt getCreatedElement()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - getCreated
```
public Date getCreated()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - setCreated
```
public ProcessRequest setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created ()
    Definition: The date when this resource was created.
  - setCreated
```
public ProcessRequest setCreated(Date theDate,
                                 TemporalPrecisionEnum thePrecision)
```
    Sets the value for created ()
    Definition: The date when this resource was created.
  - setCreatedWithSecondsPrecision
```
public ProcessRequest setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created ()
    Definition: The date when this resource was created.
  - getTarget
```
public ResourceReferenceDt getTarget()
```
    Gets the value(s) for target (). creating it if it does not exist. Will not return null.
    Definition: The organization which is the target of the request.
  - setTarget
```
public ProcessRequest setTarget(ResourceReferenceDt theValue)
```
    Sets the value(s) for target ()
    Definition: The organization which is the target of the request.
  - getProvider
```
public ResourceReferenceDt getProvider()
```
    Gets the value(s) for provider (). creating it if it does not exist. Will not return null.
    Definition: The practitioner who is responsible for the action specified in thise request.
  - setProvider
```
public ProcessRequest setProvider(ResourceReferenceDt theValue)
```
    Sets the value(s) for provider ()
    Definition: The practitioner who is responsible for the action specified in thise request.
  - getOrganization
```
public ResourceReferenceDt getOrganization()
```
    Gets the value(s) for organization (). creating it if it does not exist. Will not return null.
    Definition: The organization which is responsible for the action speccified in thise request.
  - setOrganization
```
public ProcessRequest setOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for organization ()
    Definition: The organization which is responsible for the action speccified in thise request.
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (). creating it if it does not exist. Will not return null.
    Definition: Reference of resource which is the target or subject of this action.
  - setRequest
```
public ProcessRequest setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request ()
    Definition: Reference of resource which is the target or subject of this action.
  - getResponse
```
public ResourceReferenceDt getResponse()
```
    Gets the value(s) for response (). creating it if it does not exist. Will not return null.
    Definition: Reference of a prior response to resource which is the target or subject of this action.
  - setResponse
```
public ProcessRequest setResponse(ResourceReferenceDt theValue)
```
    Sets the value(s) for response ()
    Definition: Reference of a prior response to resource which is the target or subject of this action.
  - getNullifyElement
```
public BooleanDt getNullifyElement()
```
    Gets the value(s) for nullify (). creating it if it does not exist. Will not return null.
    Definition: If true remove all history excluding audit.
  - getNullify
```
public Boolean getNullify()
```
    Gets the value(s) for nullify (). creating it if it does not exist. Will not return null.
    Definition: If true remove all history excluding audit.
  - setNullify
```
public ProcessRequest setNullify(BooleanDt theValue)
```
    Sets the value(s) for nullify ()
    Definition: If true remove all history excluding audit.
  - setNullify
```
public ProcessRequest setNullify(boolean theBoolean)
```
    Sets the value for nullify ()
    Definition: If true remove all history excluding audit.
  - getReferenceElement
```
public StringDt getReferenceElement()
```
    Gets the value(s) for reference (). creating it if it does not exist. Will not return null.
    Definition: A reference to supply which authenticates the process.
  - getReference
```
public String getReference()
```
    Gets the value(s) for reference (). creating it if it does not exist. Will not return null.
    Definition: A reference to supply which authenticates the process.
  - setReference
```
public ProcessRequest setReference(StringDt theValue)
```
    Sets the value(s) for reference ()
    Definition: A reference to supply which authenticates the process.
  - setReference
```
public ProcessRequest setReference(String theString)
```
    Sets the value for reference ()
    Definition: A reference to supply which authenticates the process.
  - getItem
```
public List<ProcessRequest.Item> getItem()
```
    Gets the value(s) for item (). creating it if it does not exist. Will not return null.
    Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
  - setItem
```
public ProcessRequest setItem(List<ProcessRequest.Item> theValue)
```
    Sets the value(s) for item ()
    Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
  - addItem
```
public ProcessRequest.Item addItem()
```
    Adds and returns a new value for item ()
    Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
  - addItem
```
public ProcessRequest addItem(ProcessRequest.Item theValue)
```
    Adds a given new value for item ()
    Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
    
    Parameters:
    
    theValue - The item to add (must not be null)
  - getItemFirstRep
```
public ProcessRequest.Item getItemFirstRep()
```
    Gets the first repetition for item (), creating it if it does not already exist.
    Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
  - getInclude
```
public List<StringDt> getInclude()
```
    Gets the value(s) for include (). creating it if it does not exist. Will not return null.
    Definition: Names of resource types to include
  - setInclude
```
public ProcessRequest setInclude(List<StringDt> theValue)
```
    Sets the value(s) for include ()
    Definition: Names of resource types to include
  - addInclude
```
public StringDt addInclude()
```
    Adds and returns a new value for include ()
    Definition: Names of resource types to include
  - addInclude
```
public ProcessRequest addInclude(StringDt theValue)
```
    Adds a given new value for include ()
    Definition: Names of resource types to include
    
    Parameters:
    
    theValue - The include to add (must not be null)
  - getIncludeFirstRep
```
public StringDt getIncludeFirstRep()
```
    Gets the first repetition for include (), creating it if it does not already exist.
    Definition: Names of resource types to include
  - addInclude
```
public ProcessRequest addInclude(String theString)
```
    Adds a new value for include ()
    Definition: Names of resource types to include
    
    Returns:
    
    Returns a reference to this object, to allow for simple chaining.
  - getExclude
```
public List<StringDt> getExclude()
```
    Gets the value(s) for exclude (). creating it if it does not exist. Will not return null.
    Definition: Names of resource types to exclude
  - setExclude
```
public ProcessRequest setExclude(List<StringDt> theValue)
```
    Sets the value(s) for exclude ()
    Definition: Names of resource types to exclude
  - addExclude
```
public StringDt addExclude()
```
    Adds and returns a new value for exclude ()
    Definition: Names of resource types to exclude
  - addExclude
```
public ProcessRequest addExclude(StringDt theValue)
```
    Adds a given new value for exclude ()
    Definition: Names of resource types to exclude
    
    Parameters:
    
    theValue - The exclude to add (must not be null)
  - getExcludeFirstRep
```
public StringDt getExcludeFirstRep()
```
    Gets the first repetition for exclude (), creating it if it does not already exist.
    Definition: Names of resource types to exclude
  - addExclude
```
public ProcessRequest addExclude(String theString)
```
    Adds a new value for exclude ()
    Definition: Names of resource types to exclude
    
    Returns:
    
    Returns a reference to this object, to allow for simple chaining.
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (). creating it if it does not exist. Will not return null.
    Definition: A period of time during which the fulfilling resources would have been created.
  - setPeriod
```
public ProcessRequest setPeriod(PeriodDt theValue)
```
    Sets the value(s) for period ()
    Definition: A period of time during which the fulfilling resources would have been created.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class ProcessRequest

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_ORGANIZATION

ORGANIZATION

SP_PROVIDER

PROVIDER

SP_ACTION

ACTION

INCLUDE_ORGANIZATION

INCLUDE_PROVIDER

Constructor Detail

ProcessRequest

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getActionElement

getAction

setAction

setAction

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getRuleset

setRuleset

getOriginalRuleset

setOriginalRuleset

getCreatedElement

getCreated

setCreated

setCreated

setCreatedWithSecondsPrecision

getTarget

setTarget

getProvider

setProvider

getOrganization

setOrganization

getRequest

setRequest

getResponse

setResponse

getNullifyElement

getNullify

setNullify

setNullify

getReferenceElement

getReference

setReference

setReference

getItem

setItem

addItem

addItem

getItemFirstRep

getInclude

setInclude

addInclude

addInclude

getIncludeFirstRep

addInclude

getExclude

setExclude

addExclude

addExclude

getExcludeFirstRep