Class Claim

  • 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 Claim
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Claim Resource ()

    Definition: A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.

    Requirements:

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

    See Also:
    Serialized Form
    • Field Detail

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: The primary identifier of the financial resource
        Type: token
        Path: Claim.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 primary identifier of the financial resource
        Type: token
        Path: Claim.identifier

      • SP_USE

        public static final String SP_USE
        Search parameter constant for use

        Description: The kind of financial resource
        Type: token
        Path: Claim.use

        See Also:
        Constant Field Values
      • USE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam USE
        Fluent Client search parameter constant for use

        Description: The kind of financial resource
        Type: token
        Path: Claim.use

      • SP_PRIORITY

        public static final String SP_PRIORITY
        Search parameter constant for priority

        Description: Processing priority requested
        Type: token
        Path: Claim.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: Processing priority requested
        Type: token
        Path: Claim.priority

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Patient
        Type: reference
        Path: Claim.patient

      • SP_PROVIDER

        public static final String SP_PROVIDER
        Search parameter constant for provider

        Description: Provider responsible for the claim
        Type: reference
        Path: Claim.provider

        See Also:
        Constant Field Values
      • PROVIDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROVIDER
        Fluent Client search parameter constant for provider

        Description: Provider responsible for the claim
        Type: reference
        Path: Claim.provider

      • 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 "Claim:patient".
      • INCLUDE_PROVIDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PROVIDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Claim:provider".
    • Constructor Detail

    • Method Detail

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

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

        Definition: The category of claim this is

      • getType

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

        Definition: The category of claim this is

      • setType

        public Claim setType​(ca.uhn.fhir.model.primitive.BoundCodeDt<ClaimTypeEnum> theValue)
        Sets the value(s) for type ()

        Definition: The category of claim this is

      • setType

        public Claim setType​(ClaimTypeEnum theValue)
        Sets the value(s) for type ()

        Definition: The category of claim this is

      • getIdentifier

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

        Definition: The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.

      • setIdentifier

        public Claim setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier ()

        Definition: The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier ()

        Definition: The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.

      • addIdentifier

        public Claim addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier ()

        Definition: The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.

        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 business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.

      • 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 specification on which this instance relies.

      • setRuleset

        public Claim setRuleset​(CodingDt theValue)
        Sets the value(s) for ruleset ()

        Definition: The version of the specification on which this instance relies.

      • getOriginalRuleset

        public CodingDt getOriginalRuleset()
        Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.

        Definition: The version of the specification from which the original instance was created.

      • setOriginalRuleset

        public Claim setOriginalRuleset​(CodingDt theValue)
        Sets the value(s) for originalRuleset ()

        Definition: The version of the specification from which the original instance was created.

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

        public Claim setCreatedWithSecondsPrecision​(Date theDate)
        Sets the value for created ()

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

      • getTarget

        public ResourceReferenceDt getTarget()
        Gets the value(s) for target (). creating it if it does not exist. Will not return null.

        Definition: Insurer Identifier, typical BIN number (6 digit).

      • getProvider

        public ResourceReferenceDt getProvider()
        Gets the value(s) for provider (). creating it if it does not exist. Will not return null.

        Definition: The provider which is responsible for the bill, claim pre-determination, pre-authorization.

      • setProvider

        public Claim setProvider​(ResourceReferenceDt theValue)
        Sets the value(s) for provider ()

        Definition: The provider which is responsible for the bill, claim pre-determination, pre-authorization.

      • 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 bill, claim pre-determination, pre-authorization.

      • setOrganization

        public Claim setOrganization​(ResourceReferenceDt theValue)
        Sets the value(s) for organization ()

        Definition: The organization which is responsible for the bill, claim pre-determination, pre-authorization.

      • getUseElement

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

        Definition: Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).

      • getUse

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

        Definition: Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).

      • setUse

        public Claim setUse​(ca.uhn.fhir.model.primitive.BoundCodeDt<UseEnum> theValue)
        Sets the value(s) for use ()

        Definition: Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).

      • setUse

        public Claim setUse​(UseEnum theValue)
        Sets the value(s) for use ()

        Definition: Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).

      • getPriority

        public CodingDt getPriority()
        Gets the value(s) for priority (). creating it if it does not exist. Will not return null.

        Definition: Immediate (stat), best effort (normal), deferred (deferred)

      • setPriority

        public Claim setPriority​(CodingDt theValue)
        Sets the value(s) for priority ()

        Definition: Immediate (stat), best effort (normal), deferred (deferred)

      • getFundsReserve

        public CodingDt getFundsReserve()
        Gets the value(s) for fundsReserve (). creating it if it does not exist. Will not return null.

        Definition: In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

      • setFundsReserve

        public Claim setFundsReserve​(CodingDt theValue)
        Sets the value(s) for fundsReserve ()

        Definition: In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.

      • getEnterer

        public ResourceReferenceDt getEnterer()
        Gets the value(s) for enterer (). creating it if it does not exist. Will not return null.

        Definition: Person who created the invoice/claim/pre-determination or pre-authorization.

      • setEnterer

        public Claim setEnterer​(ResourceReferenceDt theValue)
        Sets the value(s) for enterer ()

        Definition: Person who created the invoice/claim/pre-determination or pre-authorization.

      • getFacility

        public ResourceReferenceDt getFacility()
        Gets the value(s) for facility (). creating it if it does not exist. Will not return null.

        Definition: Facility where the services were provided.

      • getPrescription

        public ResourceReferenceDt getPrescription()
        Gets the value(s) for prescription (). creating it if it does not exist. Will not return null.

        Definition: Prescription to support the dispensing of Pharmacy or Vision products.

      • setPrescription

        public Claim setPrescription​(ResourceReferenceDt theValue)
        Sets the value(s) for prescription ()

        Definition: Prescription to support the dispensing of Pharmacy or Vision products.

      • getOriginalPrescription

        public ResourceReferenceDt getOriginalPrescription()
        Gets the value(s) for originalPrescription (). creating it if it does not exist. Will not return null.

        Definition: Original prescription to support the dispensing of pharmacy services, medications or products.

      • setOriginalPrescription

        public Claim setOriginalPrescription​(ResourceReferenceDt theValue)
        Sets the value(s) for originalPrescription ()

        Definition: Original prescription to support the dispensing of pharmacy services, medications or products.

      • getPayee

        public Claim.Payee getPayee()
        Gets the value(s) for payee (). creating it if it does not exist. Will not return null.

        Definition: The party to be reimbursed for the services.

      • setPayee

        public Claim setPayee​(Claim.Payee theValue)
        Sets the value(s) for payee ()

        Definition: The party to be reimbursed for the services.

      • getReferral

        public ResourceReferenceDt getReferral()
        Gets the value(s) for referral (). creating it if it does not exist. Will not return null.

        Definition: The referral resource which lists the date, practitioner, reason and other supporting information.

      • setReferral

        public Claim setReferral​(ResourceReferenceDt theValue)
        Sets the value(s) for referral ()

        Definition: The referral resource which lists the date, practitioner, reason and other supporting information.

      • getDiagnosis

        public List<Claim.DiagnosisgetDiagnosis()
        Gets the value(s) for diagnosis (). creating it if it does not exist. Will not return null.

        Definition: Ordered list of patient diagnosis for which care is sought.

      • setDiagnosis

        public Claim setDiagnosis​(List<Claim.Diagnosis> theValue)
        Sets the value(s) for diagnosis ()

        Definition: Ordered list of patient diagnosis for which care is sought.

      • addDiagnosis

        public Claim.Diagnosis addDiagnosis()
        Adds and returns a new value for diagnosis ()

        Definition: Ordered list of patient diagnosis for which care is sought.

      • addDiagnosis

        public Claim addDiagnosis​(Claim.Diagnosis theValue)
        Adds a given new value for diagnosis ()

        Definition: Ordered list of patient diagnosis for which care is sought.

        Parameters:
        theValue - The diagnosis to add (must not be null)
      • getDiagnosisFirstRep

        public Claim.Diagnosis getDiagnosisFirstRep()
        Gets the first repetition for diagnosis (), creating it if it does not already exist.

        Definition: Ordered list of patient diagnosis for which care is sought.

      • getCondition

        public List<CodingDtgetCondition()
        Gets the value(s) for condition (). creating it if it does not exist. Will not return null.

        Definition: List of patient conditions for which care is sought.

      • setCondition

        public Claim setCondition​(List<CodingDt> theValue)
        Sets the value(s) for condition ()

        Definition: List of patient conditions for which care is sought.

      • addCondition

        public CodingDt addCondition()
        Adds and returns a new value for condition ()

        Definition: List of patient conditions for which care is sought.

      • addCondition

        public Claim addCondition​(CodingDt theValue)
        Adds a given new value for condition ()

        Definition: List of patient conditions for which care is sought.

        Parameters:
        theValue - The condition to add (must not be null)
      • getConditionFirstRep

        public CodingDt getConditionFirstRep()
        Gets the first repetition for condition (), creating it if it does not already exist.

        Definition: List of patient conditions for which care is sought.

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (). creating it if it does not exist. Will not return null.

        Definition: Patient Resource

      • getCoverage

        public List<Claim.CoveragegetCoverage()
        Gets the value(s) for coverage (). creating it if it does not exist. Will not return null.

        Definition: Financial instrument by which payment information for health care

      • setCoverage

        public Claim setCoverage​(List<Claim.Coverage> theValue)
        Sets the value(s) for coverage ()

        Definition: Financial instrument by which payment information for health care

      • addCoverage

        public Claim.Coverage addCoverage()
        Adds and returns a new value for coverage ()

        Definition: Financial instrument by which payment information for health care

      • addCoverage

        public Claim addCoverage​(Claim.Coverage theValue)
        Adds a given new value for coverage ()

        Definition: Financial instrument by which payment information for health care

        Parameters:
        theValue - The coverage to add (must not be null)
      • getCoverageFirstRep

        public Claim.Coverage getCoverageFirstRep()
        Gets the first repetition for coverage (), creating it if it does not already exist.

        Definition: Financial instrument by which payment information for health care

      • getException

        public List<CodingDtgetException()
        Gets the value(s) for exception (). creating it if it does not exist. Will not return null.

        Definition: Factors which may influence the applicability of coverage.

      • setException

        public Claim setException​(List<CodingDt> theValue)
        Sets the value(s) for exception ()

        Definition: Factors which may influence the applicability of coverage.

      • addException

        public CodingDt addException()
        Adds and returns a new value for exception ()

        Definition: Factors which may influence the applicability of coverage.

      • addException

        public Claim addException​(CodingDt theValue)
        Adds a given new value for exception ()

        Definition: Factors which may influence the applicability of coverage.

        Parameters:
        theValue - The exception to add (must not be null)
      • getExceptionFirstRep

        public CodingDt getExceptionFirstRep()
        Gets the first repetition for exception (), creating it if it does not already exist.

        Definition: Factors which may influence the applicability of coverage.

      • getSchoolElement

        public ca.uhn.fhir.model.primitive.StringDt getSchoolElement()
        Gets the value(s) for school (). creating it if it does not exist. Will not return null.

        Definition: Name of school for over-aged dependents.

      • getSchool

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

        Definition: Name of school for over-aged dependents.

      • setSchool

        public Claim setSchool​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for school ()

        Definition: Name of school for over-aged dependents.

      • setSchool

        public Claim setSchool​(String theString)
        Sets the value for school ()

        Definition: Name of school for over-aged dependents.

      • getAccidentElement

        public ca.uhn.fhir.model.primitive.DateDt getAccidentElement()
        Gets the value(s) for accident (). creating it if it does not exist. Will not return null.

        Definition: Date of an accident which these services are addressing.

      • getAccident

        public Date getAccident()
        Gets the value(s) for accident (). creating it if it does not exist. This method may return null.

        Definition: Date of an accident which these services are addressing.

      • setAccident

        public Claim setAccident​(ca.uhn.fhir.model.primitive.DateDt theValue)
        Sets the value(s) for accident ()

        Definition: Date of an accident which these services are addressing.

      • setAccident

        public Claim setAccident​(Date theDate,
                                 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for accident ()

        Definition: Date of an accident which these services are addressing.

      • setAccidentWithDayPrecision

        public Claim setAccidentWithDayPrecision​(Date theDate)
        Sets the value for accident ()

        Definition: Date of an accident which these services are addressing.

      • getAccidentType

        public CodingDt getAccidentType()
        Gets the value(s) for accidentType (). creating it if it does not exist. Will not return null.

        Definition: Type of accident: work, auto, etc.

      • setAccidentType

        public Claim setAccidentType​(CodingDt theValue)
        Sets the value(s) for accidentType ()

        Definition: Type of accident: work, auto, etc.

      • getInterventionException

        public List<CodingDtgetInterventionException()
        Gets the value(s) for interventionException (). creating it if it does not exist. Will not return null.

        Definition: A list of intervention and exception codes which may influence the adjudication of the claim.

      • setInterventionException

        public Claim setInterventionException​(List<CodingDt> theValue)
        Sets the value(s) for interventionException ()

        Definition: A list of intervention and exception codes which may influence the adjudication of the claim.

      • addInterventionException

        public CodingDt addInterventionException()
        Adds and returns a new value for interventionException ()

        Definition: A list of intervention and exception codes which may influence the adjudication of the claim.

      • addInterventionException

        public Claim addInterventionException​(CodingDt theValue)
        Adds a given new value for interventionException ()

        Definition: A list of intervention and exception codes which may influence the adjudication of the claim.

        Parameters:
        theValue - The interventionException to add (must not be null)
      • getInterventionExceptionFirstRep

        public CodingDt getInterventionExceptionFirstRep()
        Gets the first repetition for interventionException (), creating it if it does not already exist.

        Definition: A list of intervention and exception codes which may influence the adjudication of the claim.

      • getItem

        public List<Claim.ItemgetItem()
        Gets the value(s) for item (). creating it if it does not exist. Will not return null.

        Definition: First tier of goods and services

      • setItem

        public Claim setItem​(List<Claim.Item> theValue)
        Sets the value(s) for item ()

        Definition: First tier of goods and services

      • addItem

        public Claim.Item addItem()
        Adds and returns a new value for item ()

        Definition: First tier of goods and services

      • addItem

        public Claim addItem​(Claim.Item theValue)
        Adds a given new value for item ()

        Definition: First tier of goods and services

        Parameters:
        theValue - The item to add (must not be null)
      • getItemFirstRep

        public Claim.Item getItemFirstRep()
        Gets the first repetition for item (), creating it if it does not already exist.

        Definition: First tier of goods and services

      • getAdditionalMaterials

        public List<CodingDtgetAdditionalMaterials()
        Gets the value(s) for additionalMaterials (). creating it if it does not exist. Will not return null.

        Definition: Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.

      • setAdditionalMaterials

        public Claim setAdditionalMaterials​(List<CodingDt> theValue)
        Sets the value(s) for additionalMaterials ()

        Definition: Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.

      • addAdditionalMaterials

        public CodingDt addAdditionalMaterials()
        Adds and returns a new value for additionalMaterials ()

        Definition: Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.

      • addAdditionalMaterials

        public Claim addAdditionalMaterials​(CodingDt theValue)
        Adds a given new value for additionalMaterials ()

        Definition: Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.

        Parameters:
        theValue - The additionalMaterials to add (must not be null)
      • getAdditionalMaterialsFirstRep

        public CodingDt getAdditionalMaterialsFirstRep()
        Gets the first repetition for additionalMaterials (), creating it if it does not already exist.

        Definition: Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.

      • getMissingTeeth

        public List<Claim.MissingTeethgetMissingTeeth()
        Gets the value(s) for missingTeeth (). creating it if it does not exist. Will not return null.

        Definition: A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.

      • setMissingTeeth

        public Claim setMissingTeeth​(List<Claim.MissingTeeth> theValue)
        Sets the value(s) for missingTeeth ()

        Definition: A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.

      • addMissingTeeth

        public Claim.MissingTeeth addMissingTeeth()
        Adds and returns a new value for missingTeeth ()

        Definition: A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.

      • addMissingTeeth

        public Claim addMissingTeeth​(Claim.MissingTeeth theValue)
        Adds a given new value for missingTeeth ()

        Definition: A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.

        Parameters:
        theValue - The missingTeeth to add (must not be null)
      • getMissingTeethFirstRep

        public Claim.MissingTeeth getMissingTeethFirstRep()
        Gets the first repetition for missingTeeth (), creating it if it does not already exist.

        Definition: A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.

      • getResourceName

        public String 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