Class ProcessResponse

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:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class ProcessResponse
extends BaseResource
implements ca.uhn.fhir.model.api.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
  • Field Details

    • 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.Include INCLUDE_REQUESTPROVIDER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessResponse:requestprovider".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: The Response business identifier

    • setIdentifier

      Sets the value(s) for identifier ()

      Definition: The Response business identifier

    • addIdentifier

      Adds and returns a new value for identifier ()

      Definition: The Response business identifier

    • addIdentifier

      Adds a given new value for identifier ()

      Definition: The Response business identifier

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: The Response business identifier

    • getRequest

      Gets the value(s) for request (). creating it if it does not exist. Will not return null.

      Definition: Original request resource reference

    • setRequest

      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 ca.uhn.fhir.model.primitive.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

      Gets the value(s) for disposition (). creating it if it does not exist. This method may return null.

      Definition: A description of the status of the adjudication or processing.

    • setDisposition

      public ProcessResponse setDisposition​(ca.uhn.fhir.model.primitive.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

      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

      Sets the value(s) for originalRuleset ()

      Definition: The style (standard) and version of the original material which was converted into this resource.

    • getCreatedElement

      public ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: The date when the enclosed suite of services were performed or completed

    • setCreated

      public ProcessResponse setCreated​(ca.uhn.fhir.model.primitive.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, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for created ()

      Definition: The date when the enclosed suite of services were performed or completed

    • setCreatedWithSecondsPrecision

      Sets the value for created ()

      Definition: The date when the enclosed suite of services were performed or completed

    • 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

      Sets the value(s) for organization ()

      Definition: The organization who produced this adjudicated response.

    • 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

      Sets the value(s) for requestProvider ()

      Definition: The practitioner who is responsible for the services rendered to the patient.

    • 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

      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

      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

      Sets the value(s) for notes ()

      Definition: Suite of processing note or additional requirements is the processing has been held.

    • addNotes

      Adds and returns a new value for notes ()

      Definition: Suite of processing note or additional requirements is the processing has been held.

    • addNotes

      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

      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

      Gets the first repetition for error (), creating it if it does not already exist.

      Definition: Processing errors.

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource