Package com.ibm.fhir.model.resource
Class Claim
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.Claim
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class Claim extends DomainResourceA provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classClaim.AccidentDetails of an accident which resulted in injuries which required the products and services listed in the claim.static classClaim.Builderstatic classClaim.CareTeamThe members of the team who provided the products and services.static classClaim.DiagnosisInformation about diagnoses relevant to the claim items.static classClaim.InsuranceFinancial instruments for reimbursement for the health care products and services specified on the claim.static classClaim.ItemA claim line.static classClaim.PayeeThe party to be reimbursed for cost of the products and services according to the terms of the policy.static classClaim.ProcedureProcedures performed on the patient relevant to the billing items with the claim.static classClaim.RelatedOther claims which are related to this claim such as prior submissions or claims for related services or for the same event.static classClaim.SupportingInfoAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static Claim.Builderbuilder()booleanequals(java.lang.Object obj)Claim.AccidentgetAccident()Details of an accident which resulted in injuries which required the products and services listed in the claim.PeriodgetBillablePeriod()The period for which charges are being submitted.java.util.List<Claim.CareTeam>getCareTeam()The members of the team who provided the products and services.DateTimegetCreated()The date this resource was created.java.util.List<Claim.Diagnosis>getDiagnosis()Information about diagnoses relevant to the claim items.ReferencegetEnterer()Individual who created the claim, predetermination or preauthorization.ReferencegetFacility()Facility where the services were provided.CodeableConceptgetFundsReserve()A code to indicate whether and for whom funds are to be reserved for future claims.java.util.List<Identifier>getIdentifier()A unique identifier assigned to this claim.java.util.List<Claim.Insurance>getInsurance()Financial instruments for reimbursement for the health care products and services specified on the claim.ReferencegetInsurer()The Insurer who is target of the request.java.util.List<Claim.Item>getItem()A claim line.ReferencegetOriginalPrescription()Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.ReferencegetPatient()The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.Claim.PayeegetPayee()The party to be reimbursed for cost of the products and services according to the terms of the policy.ReferencegetPrescription()Prescription to support the dispensing of pharmacy, device or vision products.CodeableConceptgetPriority()The provider-required urgency of processing the request.java.util.List<Claim.Procedure>getProcedure()Procedures performed on the patient relevant to the billing items with the claim.ReferencegetProvider()The provider which is responsible for the claim, predetermination or preauthorization.ReferencegetReferral()A reference to a referral resource.java.util.List<Claim.Related>getRelated()Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.ClaimStatusgetStatus()The status of the resource instance.CodeableConceptgetSubType()A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.java.util.List<Claim.SupportingInfo>getSupportingInfo()Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.MoneygetTotal()The total value of the all the items in the claim.CodeableConceptgetType()The category of claim, e.g.UsegetUse()A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.booleanhasChildren()inthashCode()Claim.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
A unique identifier assigned to this claim.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getStatus
public ClaimStatus getStatus()
The status of the resource instance.- Returns:
- An immutable object of type
ClaimStatusthat is non-null.
-
getType
public CodeableConcept getType()
The category of claim, e.g. oral, pharmacy, vision, institutional, professional.- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getSubType
public CodeableConcept getSubType()
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getUse
public Use getUse()
A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.- Returns:
- An immutable object of type
Usethat is non-null.
-
getPatient
public Reference getPatient()
The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.- Returns:
- An immutable object of type
Referencethat is non-null.
-
getBillablePeriod
public Period getBillablePeriod()
The period for which charges are being submitted.- Returns:
- An immutable object of type
Periodthat may be null.
-
getCreated
public DateTime getCreated()
The date this resource was created.- Returns:
- An immutable object of type
DateTimethat is non-null.
-
getEnterer
public Reference getEnterer()
Individual who created the claim, predetermination or preauthorization.- Returns:
- An immutable object of type
Referencethat may be null.
-
getInsurer
public Reference getInsurer()
The Insurer who is target of the request.- Returns:
- An immutable object of type
Referencethat may be null.
-
getProvider
public Reference getProvider()
The provider which is responsible for the claim, predetermination or preauthorization.- Returns:
- An immutable object of type
Referencethat is non-null.
-
getPriority
public CodeableConcept getPriority()
The provider-required urgency of processing the request. Typical values include: stat, routine deferred.- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getFundsReserve
public CodeableConcept getFundsReserve()
A code to indicate whether and for whom funds are to be reserved for future claims.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getRelated
public java.util.List<Claim.Related> getRelated()
Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Relatedthat may be empty.
-
getPrescription
public Reference getPrescription()
Prescription to support the dispensing of pharmacy, device or vision products.- Returns:
- An immutable object of type
Referencethat may be null.
-
getOriginalPrescription
public Reference getOriginalPrescription()
Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.- Returns:
- An immutable object of type
Referencethat may be null.
-
getPayee
public Claim.Payee getPayee()
The party to be reimbursed for cost of the products and services according to the terms of the policy.- Returns:
- An immutable object of type
Claim.Payeethat may be null.
-
getReferral
public Reference getReferral()
A reference to a referral resource.- Returns:
- An immutable object of type
Referencethat may be null.
-
getFacility
public Reference getFacility()
Facility where the services were provided.- Returns:
- An immutable object of type
Referencethat may be null.
-
getCareTeam
public java.util.List<Claim.CareTeam> getCareTeam()
The members of the team who provided the products and services.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.CareTeamthat may be empty.
-
getSupportingInfo
public java.util.List<Claim.SupportingInfo> getSupportingInfo()
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.SupportingInfothat may be empty.
-
getDiagnosis
public java.util.List<Claim.Diagnosis> getDiagnosis()
Information about diagnoses relevant to the claim items.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Diagnosisthat may be empty.
-
getProcedure
public java.util.List<Claim.Procedure> getProcedure()
Procedures performed on the patient relevant to the billing items with the claim.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Procedurethat may be empty.
-
getInsurance
public java.util.List<Claim.Insurance> getInsurance()
Financial instruments for reimbursement for the health care products and services specified on the claim.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Insurancethat is non-empty.
-
getAccident
public Claim.Accident getAccident()
Details of an accident which resulted in injuries which required the products and services listed in the claim.- Returns:
- An immutable object of type
Claim.Accidentthat may be null.
-
getItem
public java.util.List<Claim.Item> getItem()
A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Itemthat may be empty.
-
getTotal
public Money getTotal()
The total value of the all the items in the claim.- Returns:
- An immutable object of type
Moneythat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public Claim.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static Claim.Builder builder()
-
-