Class ExplanationOfBenefit

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.ExplanationOfBenefit
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 ExplanationOfBenefit extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR ExplanationOfBenefit Resource ()

Definition: This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

Requirements:

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

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: ExplanationOfBenefit.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: ExplanationOfBenefit.identifier

  • 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

    • getOutcomeElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum> getOutcomeElement()
      Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.

      Definition: Transaction status: error, complete

    • getOutcome

      public String getOutcome()
      Gets the value(s) for outcome (). creating it if it does not exist. This method may return null.

      Definition: Transaction status: error, complete

    • setOutcome

      public ExplanationOfBenefit setOutcome(ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum> theValue)
      Sets the value(s) for outcome ()

      Definition: Transaction status: error, complete

    • setOutcome

      Sets the value(s) for outcome ()

      Definition: Transaction status: error, complete

    • 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.

    • 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.

    • setDisposition

      public ExplanationOfBenefit setDisposition(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for disposition ()

      Definition: A description of the status of the adjudication.

    • setDisposition

      Sets the value for disposition ()

      Definition: A description of the status of the adjudication.

    • 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

      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 ExplanationOfBenefit 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 ExplanationOfBenefit 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 Insurer who produced this adjudicated response.

    • setOrganization

      Sets the value(s) for organization ()

      Definition: The Insurer 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.

    • 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