ProcessResponse (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.ProcessResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class ProcessResponse
extends BaseResource
implements IResource
```
HAPI/FHIR ProcessResponse Resource ()
Definition: This resource provides processing status, errors and notes from the processing of a resource.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcessResponse.Notes
Block class for child element: ProcessResponse.notes ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcessResponse.Notes` Block class for child element: ProcessResponse.notes ()

Field Summary

Fields
Modifier and Type	Field and Description
`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_REQUEST` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REQUESTORGANIZATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REQUESTPROVIDER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`ORGANIZATION` Fluent Client search parameter constant for organization
`static ReferenceClientParam`	`REQUEST` Fluent Client search parameter constant for request
`static ReferenceClientParam`	`REQUESTORGANIZATION` Fluent Client search parameter constant for requestorganization
`static ReferenceClientParam`	`REQUESTPROVIDER` Fluent Client search parameter constant for requestprovider
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_ORGANIZATION` Search parameter constant for organization
`static String`	`SP_REQUEST` Search parameter constant for request
`static String`	`SP_REQUESTORGANIZATION` Search parameter constant for requestorganization
`static String`	`SP_REQUESTPROVIDER` Search parameter constant for requestprovider

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

ProcessResponse()

Constructors
Constructor and Description
`ProcessResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodingDt`	`addError()` Adds and returns a new value for error ()
`ProcessResponse`	`addError(CodingDt theValue)` Adds a given new value for error ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`ProcessResponse`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`ProcessResponse.Notes`	`addNotes()` Adds and returns a new value for notes ()
`ProcessResponse`	`addNotes(ProcessResponse.Notes theValue)` Adds a given new value for notes ()
`<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 ().
`String`	`getDisposition()` Gets the value(s) for disposition ().
`StringDt`	`getDispositionElement()` Gets the value(s) for disposition ().
`List<CodingDt>`	`getError()` Gets the value(s) for error ().
`CodingDt`	`getErrorFirstRep()` Gets the first repetition for error (), creating it if it does not already exist.
`CodingDt`	`getForm()` Gets the value(s) for form ().
`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<ProcessResponse.Notes>`	`getNotes()` Gets the value(s) for notes ().
`ProcessResponse.Notes`	`getNotesFirstRep()` Gets the first repetition for notes (), creating it if it does not already exist.
`ResourceReferenceDt`	`getOrganization()` Gets the value(s) for organization ().
`CodingDt`	`getOriginalRuleset()` Gets the value(s) for originalRuleset ().
`CodingDt`	`getOutcome()` Gets the value(s) for outcome ().
`ResourceReferenceDt`	`getRequest()` Gets the value(s) for request ().
`ResourceReferenceDt`	`getRequestOrganization()` Gets the value(s) for requestOrganization ().
`ResourceReferenceDt`	`getRequestProvider()` Gets the value(s) for requestProvider ().
`String`	`getResourceName()`
`CodingDt`	`getRuleset()` Gets the value(s) for ruleset ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`ProcessResponse`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created ()
`ProcessResponse`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created ()
`ProcessResponse`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created ()
`ProcessResponse`	`setDisposition(String theString)` Sets the value for disposition ()
`ProcessResponse`	`setDisposition(StringDt theValue)` Sets the value(s) for disposition ()
`ProcessResponse`	`setError(List<CodingDt> theValue)` Sets the value(s) for error ()
`ProcessResponse`	`setForm(CodingDt theValue)` Sets the value(s) for form ()
`ProcessResponse`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`ProcessResponse`	`setNotes(List<ProcessResponse.Notes> theValue)` Sets the value(s) for notes ()
`ProcessResponse`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`ProcessResponse`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`ProcessResponse`	`setOutcome(CodingDt theValue)` Sets the value(s) for outcome ()
`ProcessResponse`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`ProcessResponse`	`setRequestOrganization(ResourceReferenceDt theValue)` Sets the value(s) for requestOrganization ()
`ProcessResponse`	`setRequestProvider(ResourceReferenceDt theValue)` Sets the value(s) for requestProvider ()
`ProcessResponse`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()

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 Explanation of Benefit
    Type: token
    Path: ProcessResponse.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 Explanation of Benefit
    Type: token
    Path: ProcessResponse.identifier
  - SP_REQUEST
```
public static final String SP_REQUEST
```
    Search parameter constant for request
    Description: The reference to the claim
    Type: reference
    Path: ProcessResponse.request
    
    See Also:
    
    Constant Field Values
  - REQUEST
```
public static final ReferenceClientParam REQUEST
```
    Fluent Client search parameter constant for request
    Description: The reference to the claim
    Type: reference
    Path: ProcessResponse.request
  - SP_ORGANIZATION
```
public static final String SP_ORGANIZATION
```
    Search parameter constant for organization
    Description: The organization who generated this resource
    Type: reference
    Path: ProcessResponse.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 resource
    Type: reference
    Path: ProcessResponse.organization
  - SP_REQUESTPROVIDER
```
public static final String SP_REQUESTPROVIDER
```
    Search parameter constant for requestprovider
    Description: The Provider who is responsible the request transaction
    Type: reference
    Path: ProcessResponse.requestProvider
    
    See Also:
    
    Constant Field Values
  - REQUESTPROVIDER
```
public static final ReferenceClientParam REQUESTPROVIDER
```
    Fluent Client search parameter constant for requestprovider
    Description: The Provider who is responsible the request transaction
    Type: reference
    Path: ProcessResponse.requestProvider
  - SP_REQUESTORGANIZATION
```
public static final String SP_REQUESTORGANIZATION
```
    Search parameter constant for requestorganization
    Description: The Organization who is responsible the request transaction
    Type: reference
    Path: ProcessResponse.requestOrganization
    
    See Also:
    
    Constant Field Values
  - REQUESTORGANIZATION
```
public static final ReferenceClientParam REQUESTORGANIZATION
```
    Fluent Client search parameter constant for requestorganization
    Description: The Organization who is responsible the request transaction
    Type: reference
    Path: ProcessResponse.requestOrganization
  - INCLUDE_ORGANIZATION
```
public static final Include INCLUDE_ORGANIZATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessResponse:organization".
  - INCLUDE_REQUEST
```
public static final Include INCLUDE_REQUEST
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessResponse:request".
  - INCLUDE_REQUESTORGANIZATION
```
public static final Include INCLUDE_REQUESTORGANIZATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessResponse:requestorganization".
  - INCLUDE_REQUESTPROVIDER
```
public static final Include INCLUDE_REQUESTPROVIDER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessResponse:requestprovider".
- Constructor Detail
  - ProcessResponse
```
public ProcessResponse()
```
- 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
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: The Response business identifier
  - setIdentifier
```
public ProcessResponse setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public ProcessResponse addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: The Response 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 Response business identifier
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (). creating it if it does not exist. Will not return null.
    Definition: Original request resource reference
  - setRequest
```
public ProcessResponse setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request ()
    Definition: Original request resource reference
  - getOutcome
```
public CodingDt getOutcome()
```
    Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.
    Definition: Transaction status: error, complete, held.
  - setOutcome
```
public ProcessResponse setOutcome(CodingDt theValue)
```
    Sets the value(s) for outcome ()
    Definition: Transaction status: error, complete, held.
  - getDispositionElement
```
public StringDt getDispositionElement()
```
    Gets the value(s) for disposition (). creating it if it does not exist. Will not return null.
    Definition: A description of the status of the adjudication or processing.
  - getDisposition
```
public String getDisposition()
```
    Gets the value(s) for disposition (). creating it if it does not exist. Will not return null.
    Definition: A description of the status of the adjudication or processing.
  - setDisposition
```
public ProcessResponse setDisposition(StringDt theValue)
```
    Sets the value(s) for disposition ()
    Definition: A description of the status of the adjudication or processing.
  - setDisposition
```
public ProcessResponse setDisposition(String theString)
```
    Sets the value for disposition ()
    Definition: A description of the status of the adjudication or processing.
  - 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 ProcessResponse 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 ProcessResponse 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 the enclosed suite of services were performed or completed
  - 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 the enclosed suite of services were performed or completed
  - setCreated
```
public ProcessResponse setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreated
```
public ProcessResponse setCreated(Date theDate,
                                  TemporalPrecisionEnum thePrecision)
```
    Sets the value for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreatedWithSecondsPrecision
```
public ProcessResponse setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - getOrganization
```
public ResourceReferenceDt getOrganization()
```
    Gets the value(s) for organization (). creating it if it does not exist. Will not return null.
    Definition: The organization who produced this adjudicated response.
  - setOrganization
```
public ProcessResponse setOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for organization ()
    Definition: The organization who produced this adjudicated response.
  - getRequestProvider
```
public ResourceReferenceDt getRequestProvider()
```
    Gets the value(s) for requestProvider (). creating it if it does not exist. Will not return null.
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - setRequestProvider
```
public ProcessResponse setRequestProvider(ResourceReferenceDt theValue)
```
    Sets the value(s) for requestProvider ()
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - getRequestOrganization
```
public ResourceReferenceDt getRequestOrganization()
```
    Gets the value(s) for requestOrganization (). creating it if it does not exist. Will not return null.
    Definition: The organization which is responsible for the services rendered to the patient.
  - setRequestOrganization
```
public ProcessResponse setRequestOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for requestOrganization ()
    Definition: The organization which is responsible for the services rendered to the patient.
  - getForm
```
public CodingDt getForm()
```
    Gets the value(s) for form (). creating it if it does not exist. Will not return null.
    Definition: The form to be used for printing the content.
  - setForm
```
public ProcessResponse setForm(CodingDt theValue)
```
    Sets the value(s) for form ()
    Definition: The form to be used for printing the content.
  - getNotes
```
public List<ProcessResponse.Notes> getNotes()
```
    Gets the value(s) for notes (). creating it if it does not exist. Will not return null.
    Definition: Suite of processing note or additional requirements is the processing has been held.
  - setNotes
```
public ProcessResponse setNotes(List<ProcessResponse.Notes> theValue)
```
    Sets the value(s) for notes ()
    Definition: Suite of processing note or additional requirements is the processing has been held.
  - addNotes
```
public ProcessResponse.Notes addNotes()
```
    Adds and returns a new value for notes ()
    Definition: Suite of processing note or additional requirements is the processing has been held.
  - addNotes
```
public ProcessResponse addNotes(ProcessResponse.Notes theValue)
```
    Adds a given new value for notes ()
    Definition: Suite of processing note or additional requirements is the processing has been held.
    
    Parameters:
    
    theValue - The notes to add (must not be null)
  - getNotesFirstRep
```
public ProcessResponse.Notes getNotesFirstRep()
```
    Gets the first repetition for notes (), creating it if it does not already exist.
    Definition: Suite of processing note or additional requirements is the processing has been held.
  - getError
```
public List<CodingDt> getError()
```
    Gets the value(s) for error (). creating it if it does not exist. Will not return null.
    Definition: Processing errors.
  - setError
```
public ProcessResponse setError(List<CodingDt> theValue)
```
    Sets the value(s) for error ()
    Definition: Processing errors.
  - addError
```
public CodingDt addError()
```
    Adds and returns a new value for error ()
    Definition: Processing errors.
  - addError
```
public ProcessResponse addError(CodingDt theValue)
```
    Adds a given new value for error ()
    Definition: Processing errors.
    
    Parameters:
    
    theValue - The error to add (must not be null)
  - getErrorFirstRep
```
public CodingDt getErrorFirstRep()
```
    Gets the first repetition for error (), creating it if it does not already exist.
    Definition: Processing errors.
  - 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 ProcessResponse

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_REQUEST

REQUEST

SP_ORGANIZATION

ORGANIZATION

SP_REQUESTPROVIDER

REQUESTPROVIDER

SP_REQUESTORGANIZATION

REQUESTORGANIZATION

INCLUDE_ORGANIZATION

INCLUDE_REQUEST

INCLUDE_REQUESTORGANIZATION

INCLUDE_REQUESTPROVIDER

Constructor Detail

ProcessResponse

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getRequest

setRequest

getOutcome

setOutcome

getDispositionElement

getDisposition

setDisposition

setDisposition

getRuleset

setRuleset

getOriginalRuleset

setOriginalRuleset

getCreatedElement

getCreated

setCreated

setCreated

setCreatedWithSecondsPrecision

getOrganization

setOrganization

getRequestProvider

setRequestProvider

getRequestOrganization

setRequestOrganization

getForm

setForm

getNotes

setNotes

addNotes

addNotes

getNotesFirstRep

getError

setError

addError

addError

getErrorFirstRep

getResourceName

getStructureFhirVersionEnum