Package org.hl7.fhir.r5.model

Class ExplanationOfBenefit

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.ExplanationOfBenefit

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class ExplanationOfBenefit
extends DomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplanationOfBenefit.AccidentComponent
static class	ExplanationOfBenefit.AddedItemBodySiteComponent
static class	ExplanationOfBenefit.AddedItemComponent
static class	ExplanationOfBenefit.AddedItemDetailComponent
static class	ExplanationOfBenefit.AddedItemDetailSubDetailComponent
static class	ExplanationOfBenefit.AdjudicationComponent
static class	ExplanationOfBenefit.BenefitBalanceComponent
static class	ExplanationOfBenefit.BenefitComponent
static class	ExplanationOfBenefit.CareTeamComponent
static class	ExplanationOfBenefit.DetailComponent
static class	ExplanationOfBenefit.DiagnosisComponent
static class	ExplanationOfBenefit.ExplanationOfBenefitEventComponent
static enum	ExplanationOfBenefit.ExplanationOfBenefitStatus
static class	ExplanationOfBenefit.ExplanationOfBenefitStatusEnumFactory
static class	ExplanationOfBenefit.InsuranceComponent
static class	ExplanationOfBenefit.ItemBodySiteComponent
static class	ExplanationOfBenefit.ItemComponent
static class	ExplanationOfBenefit.ItemReviewOutcomeComponent
static class	ExplanationOfBenefit.NoteComponent
static class	ExplanationOfBenefit.PayeeComponent
static class	ExplanationOfBenefit.PaymentComponent
static class	ExplanationOfBenefit.ProcedureComponent
static class	ExplanationOfBenefit.RelatedClaimComponent
static class	ExplanationOfBenefit.SubDetailComponent
static class	ExplanationOfBenefit.SupportingInformationComponent
static class	ExplanationOfBenefit.TotalComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected ExplanationOfBenefit.AccidentComponent	accident	Details of a accident which resulted in injuries which required the products and services listed in the claim.
protected List<ExplanationOfBenefit.AddedItemComponent>	addItem	The first-tier service adjudications for payor added product or service lines.
protected List<ExplanationOfBenefit.AdjudicationComponent>	adjudication	The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
protected List<ExplanationOfBenefit.BenefitBalanceComponent>	benefitBalance	Balance by Benefit Category.
protected Period	benefitPeriod	The term of the benefits documented in this response.
protected Period	billablePeriod	The period for which charges are being submitted.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CARE_TEAM	Fluent Client search parameter constant for care-team
protected List<ExplanationOfBenefit.CareTeamComponent>	careTeam	The members of the team who provided the products and services.
protected Reference	claim	The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CLAIM	Fluent Client search parameter constant for claim
protected Reference	claimResponse	The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COVERAGE	Fluent Client search parameter constant for coverage
protected DateTimeType	created	The date this resource was created.
static final ca.uhn.fhir.rest.gclient.DateClientParam	CREATED	Fluent Client search parameter constant for created
protected CodeableConcept	decision	The result of the claim, predetermination, or preauthorization adjudication.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DETAIL_UDI	Fluent Client search parameter constant for detail-udi
protected List<ExplanationOfBenefit.DiagnosisComponent>	diagnosis	Information about diagnoses relevant to the claim items.
protected CodeableConcept	diagnosisRelatedGroup	A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
protected StringType	disposition	A human readable description of the status of the adjudication.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DISPOSITION	Fluent Client search parameter constant for disposition
protected List<Reference>	encounter	Healthcare encounters related to this claim.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected Reference	enterer	Individual who created the claim, predetermination or preauthorization.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENTERER	Fluent Client search parameter constant for enterer
protected List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent>	event	Information code for an event with a corresponding date or period.
protected Reference	facility	Facility where the services were provided.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FACILITY	Fluent Client search parameter constant for facility
protected Attachment	form	The actual form, by reference or inclusion, for printing the content or an EOB.
protected CodeableConcept	formCode	A code for the form to be used for printing the content.
protected CodeableConcept	fundsReserve	A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
protected CodeableConcept	fundsReserveRequested	A code to indicate whether and for whom funds are to be reserved for future claims.
protected List<Identifier>	identifier	A unique identifier assigned to this explanation of benefit.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_CARE_TEAM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CLAIM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_COVERAGE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DETAIL_UDI	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENTERER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FACILITY	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ITEM_UDI	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PAYEE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PROCEDURE_UDI	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PROVIDER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBDETAIL_UDI	Constant for fluent queries to be used to add include statements.
protected List<ExplanationOfBenefit.InsuranceComponent>	insurance	Financial instruments for reimbursement for the health care products and services specified on the claim.
protected Reference	insurer	The party responsible for authorization, adjudication and reimbursement.
protected List<ExplanationOfBenefit.ItemComponent>	item	A claim line.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ITEM_UDI	Fluent Client search parameter constant for item-udi
protected Reference	originalPrescription	Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
protected Enumeration<Enumerations.ClaimProcessingCodes>	outcome	The outcome of the claim, predetermination, or preauthorization processing.
protected Reference	patient	The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Money	patientPaid	The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
protected ExplanationOfBenefit.PayeeComponent	payee	The party to be reimbursed for cost of the products and services according to the terms of the policy.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PAYEE	Fluent Client search parameter constant for payee
protected ExplanationOfBenefit.PaymentComponent	payment	Payment details for the adjudication of the claim.
protected List<StringType>	preAuthRef	Reference from the Insurer which is used in later communications which refers to this adjudication.
protected List<Period>	preAuthRefPeriod	The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
protected PositiveIntType	precedence	This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
protected Reference	prescription	Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought.
protected CodeableConcept	priority	The provider-required urgency of processing the request.
protected List<ExplanationOfBenefit.ProcedureComponent>	procedure	Procedures performed on the patient relevant to the billing items with the claim.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PROCEDURE_UDI	Fluent Client search parameter constant for procedure-udi
protected List<ExplanationOfBenefit.NoteComponent>	processNote	A note that describes or explains adjudication results in a human readable form.
protected Reference	provider	The provider which is responsible for the claim, predetermination or preauthorization.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PROVIDER	Fluent Client search parameter constant for provider
protected Reference	referral	The referral information received by the claim author, it is not to be used when the author generates a referral for a patient.
protected List<ExplanationOfBenefit.RelatedClaimComponent>	related	Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
static final String	SP_CARE_TEAM	Search parameter: care-team
static final String	SP_CLAIM	Search parameter: claim
static final String	SP_COVERAGE	Search parameter: coverage
static final String	SP_CREATED	Search parameter: created
static final String	SP_DETAIL_UDI	Search parameter: detail-udi
static final String	SP_DISPOSITION	Search parameter: disposition
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_ENTERER	Search parameter: enterer
static final String	SP_FACILITY	Search parameter: facility
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_ITEM_UDI	Search parameter: item-udi
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PAYEE	Search parameter: payee
static final String	SP_PROCEDURE_UDI	Search parameter: procedure-udi
static final String	SP_PROVIDER	Search parameter: provider
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBDETAIL_UDI	Search parameter: subdetail-udi
protected Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus>	status	The status of the resource instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBDETAIL_UDI	Fluent Client search parameter constant for subdetail-udi
protected CodeableConcept	subType	A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
protected List<ExplanationOfBenefit.SupportingInformationComponent>	supportingInfo	Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
protected List<ExplanationOfBenefit.TotalComponent>	total	Categorized monetary totals for the adjudication.
protected List<Identifier>	traceNumber	Trace number for tracking purposes.
protected CodeableConcept	type	The category of claim, e.g.
protected Enumeration<Enumerations.Use>	use	A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ExplanationOfBenefit()	Constructor
ExplanationOfBenefit(ExplanationOfBenefit.ExplanationOfBenefitStatus status, CodeableConcept type, Enumerations.Use use, Reference patient, Date created, Enumerations.ClaimProcessingCodes outcome)	Constructor

Method Summary

Modifier and Type	Method	Description
ExplanationOfBenefit.AddedItemComponent	addAddItem()
ExplanationOfBenefit	addAddItem(ExplanationOfBenefit.AddedItemComponent t)
ExplanationOfBenefit.AdjudicationComponent	addAdjudication()
ExplanationOfBenefit	addAdjudication(ExplanationOfBenefit.AdjudicationComponent t)
ExplanationOfBenefit.BenefitBalanceComponent	addBenefitBalance()
ExplanationOfBenefit	addBenefitBalance(ExplanationOfBenefit.BenefitBalanceComponent t)
ExplanationOfBenefit.CareTeamComponent	addCareTeam()
ExplanationOfBenefit	addCareTeam(ExplanationOfBenefit.CareTeamComponent t)
Base	addChild(String name)
ExplanationOfBenefit.DiagnosisComponent	addDiagnosis()
ExplanationOfBenefit	addDiagnosis(ExplanationOfBenefit.DiagnosisComponent t)
Reference	addEncounter()
ExplanationOfBenefit	addEncounter(Reference t)
ExplanationOfBenefit.ExplanationOfBenefitEventComponent	addEvent()
ExplanationOfBenefit	addEvent(ExplanationOfBenefit.ExplanationOfBenefitEventComponent t)
Identifier	addIdentifier()
ExplanationOfBenefit	addIdentifier(Identifier t)
ExplanationOfBenefit.InsuranceComponent	addInsurance()
ExplanationOfBenefit	addInsurance(ExplanationOfBenefit.InsuranceComponent t)
ExplanationOfBenefit.ItemComponent	addItem()
ExplanationOfBenefit	addItem(ExplanationOfBenefit.ItemComponent t)
ExplanationOfBenefit	addPreAuthRef(String value)
StringType	addPreAuthRefElement()
Period	addPreAuthRefPeriod()
ExplanationOfBenefit	addPreAuthRefPeriod(Period t)
ExplanationOfBenefit.ProcedureComponent	addProcedure()
ExplanationOfBenefit	addProcedure(ExplanationOfBenefit.ProcedureComponent t)
ExplanationOfBenefit.NoteComponent	addProcessNote()
ExplanationOfBenefit	addProcessNote(ExplanationOfBenefit.NoteComponent t)
ExplanationOfBenefit.RelatedClaimComponent	addRelated()
ExplanationOfBenefit	addRelated(ExplanationOfBenefit.RelatedClaimComponent t)
ExplanationOfBenefit.SupportingInformationComponent	addSupportingInfo()
ExplanationOfBenefit	addSupportingInfo(ExplanationOfBenefit.SupportingInformationComponent t)
ExplanationOfBenefit.TotalComponent	addTotal()
ExplanationOfBenefit	addTotal(ExplanationOfBenefit.TotalComponent t)
Identifier	addTraceNumber()
ExplanationOfBenefit	addTraceNumber(Identifier t)
ExplanationOfBenefit	copy()
void	copyValues(ExplanationOfBenefit dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
ExplanationOfBenefit.AccidentComponent	getAccident()
List<ExplanationOfBenefit.AddedItemComponent>	getAddItem()
ExplanationOfBenefit.AddedItemComponent	getAddItemFirstRep()
List<ExplanationOfBenefit.AdjudicationComponent>	getAdjudication()
ExplanationOfBenefit.AdjudicationComponent	getAdjudicationFirstRep()
List<ExplanationOfBenefit.BenefitBalanceComponent>	getBenefitBalance()
ExplanationOfBenefit.BenefitBalanceComponent	getBenefitBalanceFirstRep()
Period	getBenefitPeriod()
Period	getBillablePeriod()
List<ExplanationOfBenefit.CareTeamComponent>	getCareTeam()
ExplanationOfBenefit.CareTeamComponent	getCareTeamFirstRep()
Reference	getClaim()
Reference	getClaimResponse()
Date	getCreated()
DateTimeType	getCreatedElement()
CodeableConcept	getDecision()
List<ExplanationOfBenefit.DiagnosisComponent>	getDiagnosis()
ExplanationOfBenefit.DiagnosisComponent	getDiagnosisFirstRep()
CodeableConcept	getDiagnosisRelatedGroup()
String	getDisposition()
StringType	getDispositionElement()
List<Reference>	getEncounter()
Reference	getEncounterFirstRep()
Reference	getEnterer()
List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent>	getEvent()
ExplanationOfBenefit.ExplanationOfBenefitEventComponent	getEventFirstRep()
Reference	getFacility()
Attachment	getForm()
CodeableConcept	getFormCode()
CodeableConcept	getFundsReserve()
CodeableConcept	getFundsReserveRequested()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<ExplanationOfBenefit.InsuranceComponent>	getInsurance()
ExplanationOfBenefit.InsuranceComponent	getInsuranceFirstRep()
Reference	getInsurer()
List<ExplanationOfBenefit.ItemComponent>	getItem()
ExplanationOfBenefit.ItemComponent	getItemFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getOriginalPrescription()
Enumerations.ClaimProcessingCodes	getOutcome()
Enumeration<Enumerations.ClaimProcessingCodes>	getOutcomeElement()
Reference	getPatient()
Money	getPatientPaid()
ExplanationOfBenefit.PayeeComponent	getPayee()
ExplanationOfBenefit.PaymentComponent	getPayment()
List<StringType>	getPreAuthRef()
List<Period>	getPreAuthRefPeriod()
Period	getPreAuthRefPeriodFirstRep()
int	getPrecedence()
PositiveIntType	getPrecedenceElement()
Reference	getPrescription()
CodeableConcept	getPriority()
List<ExplanationOfBenefit.ProcedureComponent>	getProcedure()
ExplanationOfBenefit.ProcedureComponent	getProcedureFirstRep()
List<ExplanationOfBenefit.NoteComponent>	getProcessNote()
ExplanationOfBenefit.NoteComponent	getProcessNoteFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getProvider()
Reference	getReferral()
List<ExplanationOfBenefit.RelatedClaimComponent>	getRelated()
ExplanationOfBenefit.RelatedClaimComponent	getRelatedFirstRep()
ResourceType	getResourceType()
ExplanationOfBenefit.ExplanationOfBenefitStatus	getStatus()
Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus>	getStatusElement()
CodeableConcept	getSubType()
List<ExplanationOfBenefit.SupportingInformationComponent>	getSupportingInfo()
ExplanationOfBenefit.SupportingInformationComponent	getSupportingInfoFirstRep()
List<ExplanationOfBenefit.TotalComponent>	getTotal()
ExplanationOfBenefit.TotalComponent	getTotalFirstRep()
List<Identifier>	getTraceNumber()
Identifier	getTraceNumberFirstRep()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
Enumerations.Use	getUse()
Enumeration<Enumerations.Use>	getUseElement()
boolean	hasAccident()
boolean	hasAddItem()
boolean	hasAdjudication()
boolean	hasBenefitBalance()
boolean	hasBenefitPeriod()
boolean	hasBillablePeriod()
boolean	hasCareTeam()
boolean	hasClaim()
boolean	hasClaimResponse()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasDecision()
boolean	hasDiagnosis()
boolean	hasDiagnosisRelatedGroup()
boolean	hasDisposition()
boolean	hasDispositionElement()
boolean	hasEncounter()
boolean	hasEnterer()
boolean	hasEvent()
boolean	hasFacility()
boolean	hasForm()
boolean	hasFormCode()
boolean	hasFundsReserve()
boolean	hasFundsReserveRequested()
boolean	hasIdentifier()
boolean	hasInsurance()
boolean	hasInsurer()
boolean	hasItem()
boolean	hasOriginalPrescription()
boolean	hasOutcome()
boolean	hasOutcomeElement()
boolean	hasPatient()
boolean	hasPatientPaid()
boolean	hasPayee()
boolean	hasPayment()
boolean	hasPreAuthRef()
boolean	hasPreAuthRef(String value)
boolean	hasPreAuthRefPeriod()
boolean	hasPrecedence()
boolean	hasPrecedenceElement()
boolean	hasPrescription()
boolean	hasPriority()
boolean	hasProcedure()
boolean	hasProcessNote()
boolean	hasProvider()
boolean	hasReferral()
boolean	hasRelated()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubType()
boolean	hasSupportingInfo()
boolean	hasTotal()
boolean	hasTraceNumber()
boolean	hasType()
boolean	hasUse()
boolean	hasUseElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ExplanationOfBenefit	setAccident(ExplanationOfBenefit.AccidentComponent value)
ExplanationOfBenefit	setAddItem(List<ExplanationOfBenefit.AddedItemComponent> theAddItem)
ExplanationOfBenefit	setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication)
ExplanationOfBenefit	setBenefitBalance(List<ExplanationOfBenefit.BenefitBalanceComponent> theBenefitBalance)
ExplanationOfBenefit	setBenefitPeriod(Period value)
ExplanationOfBenefit	setBillablePeriod(Period value)
ExplanationOfBenefit	setCareTeam(List<ExplanationOfBenefit.CareTeamComponent> theCareTeam)
ExplanationOfBenefit	setClaim(Reference value)
ExplanationOfBenefit	setClaimResponse(Reference value)
ExplanationOfBenefit	setCreated(Date value)
ExplanationOfBenefit	setCreatedElement(DateTimeType value)
ExplanationOfBenefit	setDecision(CodeableConcept value)
ExplanationOfBenefit	setDiagnosis(List<ExplanationOfBenefit.DiagnosisComponent> theDiagnosis)
ExplanationOfBenefit	setDiagnosisRelatedGroup(CodeableConcept value)
ExplanationOfBenefit	setDisposition(String value)
ExplanationOfBenefit	setDispositionElement(StringType value)
ExplanationOfBenefit	setEncounter(List<Reference> theEncounter)
ExplanationOfBenefit	setEnterer(Reference value)
ExplanationOfBenefit	setEvent(List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent> theEvent)
ExplanationOfBenefit	setFacility(Reference value)
ExplanationOfBenefit	setForm(Attachment value)
ExplanationOfBenefit	setFormCode(CodeableConcept value)
ExplanationOfBenefit	setFundsReserve(CodeableConcept value)
ExplanationOfBenefit	setFundsReserveRequested(CodeableConcept value)
ExplanationOfBenefit	setIdentifier(List<Identifier> theIdentifier)
ExplanationOfBenefit	setInsurance(List<ExplanationOfBenefit.InsuranceComponent> theInsurance)
ExplanationOfBenefit	setInsurer(Reference value)
ExplanationOfBenefit	setItem(List<ExplanationOfBenefit.ItemComponent> theItem)
ExplanationOfBenefit	setOriginalPrescription(Reference value)
ExplanationOfBenefit	setOutcome(Enumerations.ClaimProcessingCodes value)
ExplanationOfBenefit	setOutcomeElement(Enumeration<Enumerations.ClaimProcessingCodes> value)
ExplanationOfBenefit	setPatient(Reference value)
ExplanationOfBenefit	setPatientPaid(Money value)
ExplanationOfBenefit	setPayee(ExplanationOfBenefit.PayeeComponent value)
ExplanationOfBenefit	setPayment(ExplanationOfBenefit.PaymentComponent value)
ExplanationOfBenefit	setPreAuthRef(List<StringType> thePreAuthRef)
ExplanationOfBenefit	setPreAuthRefPeriod(List<Period> thePreAuthRefPeriod)
ExplanationOfBenefit	setPrecedence(int value)
ExplanationOfBenefit	setPrecedenceElement(PositiveIntType value)
ExplanationOfBenefit	setPrescription(Reference value)
ExplanationOfBenefit	setPriority(CodeableConcept value)
ExplanationOfBenefit	setProcedure(List<ExplanationOfBenefit.ProcedureComponent> theProcedure)
ExplanationOfBenefit	setProcessNote(List<ExplanationOfBenefit.NoteComponent> theProcessNote)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ExplanationOfBenefit	setProvider(Reference value)
ExplanationOfBenefit	setReferral(Reference value)
ExplanationOfBenefit	setRelated(List<ExplanationOfBenefit.RelatedClaimComponent> theRelated)
ExplanationOfBenefit	setStatus(ExplanationOfBenefit.ExplanationOfBenefitStatus value)
ExplanationOfBenefit	setStatusElement(Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> value)
ExplanationOfBenefit	setSubType(CodeableConcept value)
ExplanationOfBenefit	setSupportingInfo(List<ExplanationOfBenefit.SupportingInformationComponent> theSupportingInfo)
ExplanationOfBenefit	setTotal(List<ExplanationOfBenefit.TotalComponent> theTotal)
ExplanationOfBenefit	setTraceNumber(List<Identifier> theTraceNumber)
ExplanationOfBenefit	setType(CodeableConcept value)
ExplanationOfBenefit	setUse(Enumerations.Use value)
ExplanationOfBenefit	setUseElement(Enumeration<Enumerations.Use> value)
protected ExplanationOfBenefit	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A unique identifier assigned to this explanation of benefit.

traceNumber

protected List<Identifier> traceNumber

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

status

protected Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> status

The status of the resource instance.

type

protected CodeableConcept type

The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

subType

protected CodeableConcept subType

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

use

protected Enumeration<Enumerations.Use> use

A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

patient

protected Reference patient

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

billablePeriod

protected Period billablePeriod

The period for which charges are being submitted.

created

protected DateTimeType created

The date this resource was created.

enterer

protected Reference enterer

Individual who created the claim, predetermination or preauthorization.

insurer

protected Reference insurer

The party responsible for authorization, adjudication and reimbursement.

provider

protected Reference provider

The provider which is responsible for the claim, predetermination or preauthorization.

priority

protected CodeableConcept priority

The provider-required urgency of processing the request. Typical values include: stat, normal deferred.

fundsReserveRequested

protected CodeableConcept fundsReserveRequested

A code to indicate whether and for whom funds are to be reserved for future claims.

fundsReserve

protected CodeableConcept fundsReserve

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

related

protected List<ExplanationOfBenefit.RelatedClaimComponent> related

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

prescription

protected Reference prescription

Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.

originalPrescription

protected Reference originalPrescription

Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

event

protected List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent> event

Information code for an event with a corresponding date or period.

payee

protected ExplanationOfBenefit.PayeeComponent payee

The party to be reimbursed for cost of the products and services according to the terms of the policy.

referral

protected Reference referral

The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.

encounter

protected List<Reference> encounter

Healthcare encounters related to this claim.

facility

protected Reference facility

Facility where the services were provided.

claim

protected Reference claim

The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

claimResponse

protected Reference claimResponse

The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.

outcome

protected Enumeration<Enumerations.ClaimProcessingCodes> outcome

The outcome of the claim, predetermination, or preauthorization processing.

decision

protected CodeableConcept decision

The result of the claim, predetermination, or preauthorization adjudication.

disposition

protected StringType disposition

A human readable description of the status of the adjudication.

preAuthRef

protected List<StringType> preAuthRef

Reference from the Insurer which is used in later communications which refers to this adjudication.

preAuthRefPeriod

protected List<Period> preAuthRefPeriod

The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

diagnosisRelatedGroup

protected CodeableConcept diagnosisRelatedGroup

A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

careTeam

protected List<ExplanationOfBenefit.CareTeamComponent> careTeam

The members of the team who provided the products and services.

supportingInfo

protected List<ExplanationOfBenefit.SupportingInformationComponent> supportingInfo

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

diagnosis

protected List<ExplanationOfBenefit.DiagnosisComponent> diagnosis

Information about diagnoses relevant to the claim items.

procedure

protected List<ExplanationOfBenefit.ProcedureComponent> procedure

Procedures performed on the patient relevant to the billing items with the claim.

precedence

protected PositiveIntType precedence

This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

insurance

protected List<ExplanationOfBenefit.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services specified on the claim.

accident

protected ExplanationOfBenefit.AccidentComponent accident

Details of a accident which resulted in injuries which required the products and services listed in the claim.

patientPaid

protected Money patientPaid

The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

item

protected List<ExplanationOfBenefit.ItemComponent> item

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

addItem

protected List<ExplanationOfBenefit.AddedItemComponent> addItem

The first-tier service adjudications for payor added product or service lines.

adjudication

protected List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

total

protected List<ExplanationOfBenefit.TotalComponent> total

Categorized monetary totals for the adjudication.

payment

protected ExplanationOfBenefit.PaymentComponent payment

Payment details for the adjudication of the claim.

formCode

protected CodeableConcept formCode

A code for the form to be used for printing the content.

form

protected Attachment form

The actual form, by reference or inclusion, for printing the content or an EOB.

processNote

protected List<ExplanationOfBenefit.NoteComponent> processNote

A note that describes or explains adjudication results in a human readable form.

benefitPeriod

protected Period benefitPeriod

The term of the benefits documented in this response.

benefitBalance

protected List<ExplanationOfBenefit.BenefitBalanceComponent> benefitBalance

Balance by Benefit Category.

SP_CARE_TEAM

public static final String SP_CARE_TEAM

Search parameter: care-team

Description: Member of the CareTeam
Type: reference
Path: ExplanationOfBenefit.careTeam.provider

See Also:

• Constant Field Values

CARE_TEAM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CARE_TEAM

Fluent Client search parameter constant for care-team

Description: Member of the CareTeam
Type: reference
Path: ExplanationOfBenefit.careTeam.provider

INCLUDE_CARE_TEAM

public static final ca.uhn.fhir.model.api.Include INCLUDE_CARE_TEAM

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:care-team".

SP_CLAIM

public static final String SP_CLAIM

Search parameter: claim

Description: The reference to the claim
Type: reference
Path: ExplanationOfBenefit.claim

See Also:

• Constant Field Values

CLAIM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CLAIM

Fluent Client search parameter constant for claim

Description: The reference to the claim
Type: reference
Path: ExplanationOfBenefit.claim

INCLUDE_CLAIM

public static final ca.uhn.fhir.model.api.Include INCLUDE_CLAIM

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:claim".

SP_COVERAGE

public static final String SP_COVERAGE

Search parameter: coverage

Description: The plan under which the claim was adjudicated
Type: reference
Path: ExplanationOfBenefit.insurance.coverage

See Also:

• Constant Field Values

COVERAGE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COVERAGE

Fluent Client search parameter constant for coverage

Description: The plan under which the claim was adjudicated
Type: reference
Path: ExplanationOfBenefit.insurance.coverage

INCLUDE_COVERAGE

public static final ca.uhn.fhir.model.api.Include INCLUDE_COVERAGE

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:coverage".

SP_CREATED

public static final String SP_CREATED

Search parameter: created

Description: The creation date for the EOB
Type: date
Path: ExplanationOfBenefit.created

See Also:

• Constant Field Values

CREATED

public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED

Fluent Client search parameter constant for created

Description: The creation date for the EOB
Type: date
Path: ExplanationOfBenefit.created

SP_DETAIL_UDI

public static final String SP_DETAIL_UDI

Search parameter: detail-udi

Description: UDI associated with a line item detail product or service
Type: reference
Path: ExplanationOfBenefit.item.detail.udi

See Also:

• Constant Field Values

DETAIL_UDI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DETAIL_UDI

Fluent Client search parameter constant for detail-udi

Description: UDI associated with a line item detail product or service
Type: reference
Path: ExplanationOfBenefit.item.detail.udi

INCLUDE_DETAIL_UDI

public static final ca.uhn.fhir.model.api.Include INCLUDE_DETAIL_UDI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:detail-udi".

SP_DISPOSITION

public static final String SP_DISPOSITION

Search parameter: disposition

Description: The contents of the disposition message
Type: string
Path: ExplanationOfBenefit.disposition

See Also:

• Constant Field Values

DISPOSITION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DISPOSITION

Fluent Client search parameter constant for disposition

Description: The contents of the disposition message
Type: string
Path: ExplanationOfBenefit.disposition

SP_ENTERER

public static final String SP_ENTERER

Search parameter: enterer

Description: The party responsible for the entry of the Claim
Type: reference
Path: ExplanationOfBenefit.enterer

See Also:

• Constant Field Values

ENTERER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER

Fluent Client search parameter constant for enterer

Description: The party responsible for the entry of the Claim
Type: reference
Path: ExplanationOfBenefit.enterer

INCLUDE_ENTERER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:enterer".

SP_FACILITY

public static final String SP_FACILITY

Search parameter: facility

Description: Facility responsible for the goods and services
Type: reference
Path: ExplanationOfBenefit.facility

See Also:

• Constant Field Values

FACILITY

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FACILITY

Fluent Client search parameter constant for facility

Description: Facility responsible for the goods and services
Type: reference
Path: ExplanationOfBenefit.facility

INCLUDE_FACILITY

public static final ca.uhn.fhir.model.api.Include INCLUDE_FACILITY

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:facility".

SP_ITEM_UDI

public static final String SP_ITEM_UDI

Search parameter: item-udi

Description: UDI associated with a line item product or service
Type: reference
Path: ExplanationOfBenefit.item.udi

See Also:

• Constant Field Values

ITEM_UDI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ITEM_UDI

Fluent Client search parameter constant for item-udi

Description: UDI associated with a line item product or service
Type: reference
Path: ExplanationOfBenefit.item.udi

INCLUDE_ITEM_UDI

public static final ca.uhn.fhir.model.api.Include INCLUDE_ITEM_UDI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:item-udi".

SP_PAYEE

public static final String SP_PAYEE

Search parameter: payee

Description: The party receiving any payment for the Claim
Type: reference
Path: ExplanationOfBenefit.payee.party

See Also:

• Constant Field Values

PAYEE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PAYEE

Fluent Client search parameter constant for payee

Description: The party receiving any payment for the Claim
Type: reference
Path: ExplanationOfBenefit.payee.party

INCLUDE_PAYEE

public static final ca.uhn.fhir.model.api.Include INCLUDE_PAYEE

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:payee".

SP_PROCEDURE_UDI

public static final String SP_PROCEDURE_UDI

Search parameter: procedure-udi

Description: UDI associated with a procedure
Type: reference
Path: ExplanationOfBenefit.procedure.udi

See Also:

• Constant Field Values

PROCEDURE_UDI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROCEDURE_UDI

Fluent Client search parameter constant for procedure-udi

Description: UDI associated with a procedure
Type: reference
Path: ExplanationOfBenefit.procedure.udi

INCLUDE_PROCEDURE_UDI

public static final ca.uhn.fhir.model.api.Include INCLUDE_PROCEDURE_UDI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:procedure-udi".

SP_PROVIDER

public static final String SP_PROVIDER

Search parameter: provider

Description: The reference to the provider
Type: reference
Path: ExplanationOfBenefit.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: The reference to the provider
Type: reference
Path: ExplanationOfBenefit.provider

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 "ExplanationOfBenefit:provider".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: Status of the instance
Type: token
Path: ExplanationOfBenefit.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: Status of the instance
Type: token
Path: ExplanationOfBenefit.status

SP_SUBDETAIL_UDI

public static final String SP_SUBDETAIL_UDI

Search parameter: subdetail-udi

Description: UDI associated with a line item detail subdetail product or service
Type: reference
Path: ExplanationOfBenefit.item.detail.subDetail.udi

See Also:

• Constant Field Values

SUBDETAIL_UDI

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBDETAIL_UDI

Fluent Client search parameter constant for subdetail-udi

Description: UDI associated with a line item detail subdetail product or service
Type: reference
Path: ExplanationOfBenefit.item.detail.subDetail.udi

INCLUDE_SUBDETAIL_UDI

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBDETAIL_UDI

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:subdetail-udi".

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "ExplanationOfBenefit:encounter".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.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: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

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 "ExplanationOfBenefit:patient".

Constructor Details

ExplanationOfBenefit

public ExplanationOfBenefit()

Constructor

ExplanationOfBenefit

public ExplanationOfBenefit(ExplanationOfBenefit.ExplanationOfBenefitStatus status,
 CodeableConcept type,
 Enumerations.Use use,
 Reference patient,
 Date created,
 Enumerations.ClaimProcessingCodes outcome)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique identifier assigned to this explanation of benefit.)

setIdentifier

public ExplanationOfBenefit setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ExplanationOfBenefit addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getTraceNumber

public List<Identifier> getTraceNumber()

Returns:

traceNumber (Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)

setTraceNumber

public ExplanationOfBenefit setTraceNumber(List<Identifier> theTraceNumber)

Returns:

Returns a reference to this for easy method chaining

hasTraceNumber

public boolean hasTraceNumber()

addTraceNumber

public Identifier addTraceNumber()

addTraceNumber

public ExplanationOfBenefit addTraceNumber(Identifier t)

getTraceNumberFirstRep

public Identifier getTraceNumberFirstRep()

Returns:

The first repetition of repeating field traceNumber, creating it if it does not already exist {3}

getStatusElement

public Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> getStatusElement()

Returns:

status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public ExplanationOfBenefit setStatusElement(Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> value)

Parameters:

value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public ExplanationOfBenefit.ExplanationOfBenefitStatus getStatus()

Returns:

The status of the resource instance.

setStatus

public ExplanationOfBenefit setStatus(ExplanationOfBenefit.ExplanationOfBenefitStatus value)

Parameters:

value - The status of the resource instance.

getType

public CodeableConcept getType()

Returns:

type (The category of claim, e.g. oral, pharmacy, vision, institutional, professional.)

hasType

public boolean hasType()

setType

public ExplanationOfBenefit setType(CodeableConcept value)

Parameters:

value - type (The category of claim, e.g. oral, pharmacy, vision, institutional, professional.)

getSubType

public CodeableConcept getSubType()

Returns:

subType (A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.)

hasSubType

public boolean hasSubType()

setSubType

public ExplanationOfBenefit setSubType(CodeableConcept value)

Parameters:

value - subType (A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.)

getUseElement

public Enumeration<Enumerations.Use> getUseElement()

Returns:

use (A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

hasUseElement

public boolean hasUseElement()

hasUse

public boolean hasUse()

setUseElement

public ExplanationOfBenefit setUseElement(Enumeration<Enumerations.Use> value)

Parameters:

value - use (A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

getUse

public Enumerations.Use getUse()

Returns:

A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

setUse

public ExplanationOfBenefit setUse(Enumerations.Use value)

Parameters:

value - A code to indicate whether the nature of the request is: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

getPatient

public Reference getPatient()

Returns:

patient (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.)

hasPatient

public boolean hasPatient()

setPatient

public ExplanationOfBenefit setPatient(Reference value)

Parameters:

value - patient (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.)

getBillablePeriod

public Period getBillablePeriod()

Returns:

billablePeriod (The period for which charges are being submitted.)

hasBillablePeriod

public boolean hasBillablePeriod()

setBillablePeriod

public ExplanationOfBenefit setBillablePeriod(Period value)

Parameters:

value - billablePeriod (The period for which charges are being submitted.)

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

created (The date this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public ExplanationOfBenefit setCreatedElement(DateTimeType value)

Parameters:

value - created (The date this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

The date this resource was created.

setCreated

public ExplanationOfBenefit setCreated(Date value)

Parameters:

value - The date this resource was created.

getEnterer

public Reference getEnterer()

Returns:

enterer (Individual who created the claim, predetermination or preauthorization.)

hasEnterer

public boolean hasEnterer()

setEnterer

public ExplanationOfBenefit setEnterer(Reference value)

Parameters:

value - enterer (Individual who created the claim, predetermination or preauthorization.)

getInsurer

public Reference getInsurer()

Returns:

insurer (The party responsible for authorization, adjudication and reimbursement.)

hasInsurer

public boolean hasInsurer()

setInsurer

public ExplanationOfBenefit setInsurer(Reference value)

Parameters:

value - insurer (The party responsible for authorization, adjudication and reimbursement.)

getProvider

public Reference getProvider()

Returns:

provider (The provider which is responsible for the claim, predetermination or preauthorization.)

hasProvider

public boolean hasProvider()

setProvider

public ExplanationOfBenefit setProvider(Reference value)

Parameters:

value - provider (The provider which is responsible for the claim, predetermination or preauthorization.)

getPriority

public CodeableConcept getPriority()

Returns:

priority (The provider-required urgency of processing the request. Typical values include: stat, normal deferred.)

hasPriority

public boolean hasPriority()

setPriority

public ExplanationOfBenefit setPriority(CodeableConcept value)

Parameters:

value - priority (The provider-required urgency of processing the request. Typical values include: stat, normal deferred.)

getFundsReserveRequested

public CodeableConcept getFundsReserveRequested()

Returns:

fundsReserveRequested (A code to indicate whether and for whom funds are to be reserved for future claims.)

hasFundsReserveRequested

public boolean hasFundsReserveRequested()

setFundsReserveRequested

public ExplanationOfBenefit setFundsReserveRequested(CodeableConcept value)

Parameters:

value - fundsReserveRequested (A code to indicate whether and for whom funds are to be reserved for future claims.)

getFundsReserve

public CodeableConcept getFundsReserve()

Returns:

fundsReserve (A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.)

hasFundsReserve

public boolean hasFundsReserve()

setFundsReserve

public ExplanationOfBenefit setFundsReserve(CodeableConcept value)

Parameters:

value - fundsReserve (A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.)

getRelated

public List<ExplanationOfBenefit.RelatedClaimComponent> getRelated()

Returns:

related (Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.)

setRelated

public ExplanationOfBenefit setRelated(List<ExplanationOfBenefit.RelatedClaimComponent> theRelated)

Returns:

Returns a reference to this for easy method chaining

hasRelated

public boolean hasRelated()

addRelated

public ExplanationOfBenefit.RelatedClaimComponent addRelated()

addRelated

public ExplanationOfBenefit addRelated(ExplanationOfBenefit.RelatedClaimComponent t)

getRelatedFirstRep

public ExplanationOfBenefit.RelatedClaimComponent getRelatedFirstRep()

Returns:

The first repetition of repeating field related, creating it if it does not already exist {3}

getPrescription

public Reference getPrescription()

Returns:

prescription (Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.)

hasPrescription

public boolean hasPrescription()

setPrescription

public ExplanationOfBenefit setPrescription(Reference value)

Parameters:

value - prescription (Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.)

getOriginalPrescription

public Reference getOriginalPrescription()

Returns:

originalPrescription (Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)

hasOriginalPrescription

public boolean hasOriginalPrescription()

setOriginalPrescription

public ExplanationOfBenefit setOriginalPrescription(Reference value)

Parameters:

value - originalPrescription (Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)

getEvent

public List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent> getEvent()

Returns:

event (Information code for an event with a corresponding date or period.)

setEvent

public ExplanationOfBenefit setEvent(List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent> theEvent)

Returns:

Returns a reference to this for easy method chaining

hasEvent

public boolean hasEvent()

addEvent

public ExplanationOfBenefit.ExplanationOfBenefitEventComponent addEvent()

addEvent

public ExplanationOfBenefit addEvent(ExplanationOfBenefit.ExplanationOfBenefitEventComponent t)

getEventFirstRep

public ExplanationOfBenefit.ExplanationOfBenefitEventComponent getEventFirstRep()

Returns:

The first repetition of repeating field event, creating it if it does not already exist {3}

getPayee

public ExplanationOfBenefit.PayeeComponent getPayee()

Returns:

payee (The party to be reimbursed for cost of the products and services according to the terms of the policy.)

hasPayee

public boolean hasPayee()

setPayee

public ExplanationOfBenefit setPayee(ExplanationOfBenefit.PayeeComponent value)

Parameters:

value - payee (The party to be reimbursed for cost of the products and services according to the terms of the policy.)

getReferral

public Reference getReferral()

Returns:

referral (The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.)

hasReferral

public boolean hasReferral()

setReferral

public ExplanationOfBenefit setReferral(Reference value)

Parameters:

value - referral (The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.)

getEncounter

public List<Reference> getEncounter()

Returns:

encounter (Healthcare encounters related to this claim.)

setEncounter

public ExplanationOfBenefit setEncounter(List<Reference> theEncounter)

Returns:

Returns a reference to this for easy method chaining

hasEncounter

public boolean hasEncounter()

addEncounter

public Reference addEncounter()

addEncounter

public ExplanationOfBenefit addEncounter(Reference t)

getEncounterFirstRep

public Reference getEncounterFirstRep()

Returns:

The first repetition of repeating field encounter, creating it if it does not already exist {3}

getFacility

public Reference getFacility()

Returns:

facility (Facility where the services were provided.)

hasFacility

public boolean hasFacility()

setFacility

public ExplanationOfBenefit setFacility(Reference value)

Parameters:

value - facility (Facility where the services were provided.)

getClaim

public Reference getClaim()

Returns:

claim (The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.)

hasClaim

public boolean hasClaim()

setClaim

public ExplanationOfBenefit setClaim(Reference value)

Parameters:

value - claim (The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.)

getClaimResponse

public Reference getClaimResponse()

Returns:

claimResponse (The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.)

hasClaimResponse

public boolean hasClaimResponse()

setClaimResponse

public ExplanationOfBenefit setClaimResponse(Reference value)

Parameters:

value - claimResponse (The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.)

getOutcomeElement

public Enumeration<Enumerations.ClaimProcessingCodes> getOutcomeElement()

Returns:

outcome (The outcome of the claim, predetermination, or preauthorization processing.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value

hasOutcomeElement

public boolean hasOutcomeElement()

hasOutcome

public boolean hasOutcome()

setOutcomeElement

public ExplanationOfBenefit setOutcomeElement(Enumeration<Enumerations.ClaimProcessingCodes> value)

Parameters:

value - outcome (The outcome of the claim, predetermination, or preauthorization processing.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value

getOutcome

public Enumerations.ClaimProcessingCodes getOutcome()

Returns:

The outcome of the claim, predetermination, or preauthorization processing.

setOutcome

public ExplanationOfBenefit setOutcome(Enumerations.ClaimProcessingCodes value)

Parameters:

value - The outcome of the claim, predetermination, or preauthorization processing.

getDecision

public CodeableConcept getDecision()

Returns:

decision (The result of the claim, predetermination, or preauthorization adjudication.)

hasDecision

public boolean hasDecision()

setDecision

public ExplanationOfBenefit setDecision(CodeableConcept value)

Parameters:

value - decision (The result of the claim, predetermination, or preauthorization adjudication.)

getDispositionElement

public StringType getDispositionElement()

Returns:

disposition (A human readable description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value

hasDispositionElement

public boolean hasDispositionElement()

hasDisposition

public boolean hasDisposition()

setDispositionElement

public ExplanationOfBenefit setDispositionElement(StringType value)

Parameters:

value - disposition (A human readable description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value

getDisposition

public String getDisposition()

Returns:

A human readable description of the status of the adjudication.

setDisposition

public ExplanationOfBenefit setDisposition(String value)

Parameters:

value - A human readable description of the status of the adjudication.

getPreAuthRef

public List<StringType> getPreAuthRef()

Returns:

preAuthRef (Reference from the Insurer which is used in later communications which refers to this adjudication.)

setPreAuthRef

public ExplanationOfBenefit setPreAuthRef(List<StringType> thePreAuthRef)

Returns:

Returns a reference to this for easy method chaining

hasPreAuthRef

public boolean hasPreAuthRef()

addPreAuthRefElement

public StringType addPreAuthRefElement()

Returns:

preAuthRef (Reference from the Insurer which is used in later communications which refers to this adjudication.)

addPreAuthRef

public ExplanationOfBenefit addPreAuthRef(String value)

Parameters:

value - preAuthRef (Reference from the Insurer which is used in later communications which refers to this adjudication.)

hasPreAuthRef

public boolean hasPreAuthRef(String value)

Parameters:

value - preAuthRef (Reference from the Insurer which is used in later communications which refers to this adjudication.)

getPreAuthRefPeriod

public List<Period> getPreAuthRefPeriod()

Returns:

preAuthRefPeriod (The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.)

setPreAuthRefPeriod

public ExplanationOfBenefit setPreAuthRefPeriod(List<Period> thePreAuthRefPeriod)

Returns:

Returns a reference to this for easy method chaining

hasPreAuthRefPeriod

public boolean hasPreAuthRefPeriod()

addPreAuthRefPeriod

public Period addPreAuthRefPeriod()

addPreAuthRefPeriod

public ExplanationOfBenefit addPreAuthRefPeriod(Period t)

getPreAuthRefPeriodFirstRep

public Period getPreAuthRefPeriodFirstRep()

Returns:

The first repetition of repeating field preAuthRefPeriod, creating it if it does not already exist {3}

getDiagnosisRelatedGroup

public CodeableConcept getDiagnosisRelatedGroup()

Returns:

diagnosisRelatedGroup (A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.)

hasDiagnosisRelatedGroup

public boolean hasDiagnosisRelatedGroup()

setDiagnosisRelatedGroup

public ExplanationOfBenefit setDiagnosisRelatedGroup(CodeableConcept value)

Parameters:

value - diagnosisRelatedGroup (A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.)

getCareTeam

public List<ExplanationOfBenefit.CareTeamComponent> getCareTeam()

Returns:

careTeam (The members of the team who provided the products and services.)

setCareTeam

public ExplanationOfBenefit setCareTeam(List<ExplanationOfBenefit.CareTeamComponent> theCareTeam)

Returns:

Returns a reference to this for easy method chaining

hasCareTeam

public boolean hasCareTeam()

addCareTeam

public ExplanationOfBenefit.CareTeamComponent addCareTeam()

addCareTeam

public ExplanationOfBenefit addCareTeam(ExplanationOfBenefit.CareTeamComponent t)

getCareTeamFirstRep

public ExplanationOfBenefit.CareTeamComponent getCareTeamFirstRep()

Returns:

The first repetition of repeating field careTeam, creating it if it does not already exist {3}

getSupportingInfo

public List<ExplanationOfBenefit.SupportingInformationComponent> getSupportingInfo()

Returns:

supportingInfo (Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.)

setSupportingInfo

public ExplanationOfBenefit setSupportingInfo(List<ExplanationOfBenefit.SupportingInformationComponent> theSupportingInfo)

Returns:

Returns a reference to this for easy method chaining

hasSupportingInfo

public boolean hasSupportingInfo()

addSupportingInfo

public ExplanationOfBenefit.SupportingInformationComponent addSupportingInfo()

addSupportingInfo

public ExplanationOfBenefit addSupportingInfo(ExplanationOfBenefit.SupportingInformationComponent t)

getSupportingInfoFirstRep

public ExplanationOfBenefit.SupportingInformationComponent getSupportingInfoFirstRep()

Returns:

The first repetition of repeating field supportingInfo, creating it if it does not already exist {3}

getDiagnosis

public List<ExplanationOfBenefit.DiagnosisComponent> getDiagnosis()

Returns:

diagnosis (Information about diagnoses relevant to the claim items.)

setDiagnosis

public ExplanationOfBenefit setDiagnosis(List<ExplanationOfBenefit.DiagnosisComponent> theDiagnosis)

Returns:

Returns a reference to this for easy method chaining

hasDiagnosis

public boolean hasDiagnosis()

addDiagnosis

public ExplanationOfBenefit.DiagnosisComponent addDiagnosis()

addDiagnosis

public ExplanationOfBenefit addDiagnosis(ExplanationOfBenefit.DiagnosisComponent t)

getDiagnosisFirstRep

public ExplanationOfBenefit.DiagnosisComponent getDiagnosisFirstRep()

Returns:

The first repetition of repeating field diagnosis, creating it if it does not already exist {3}

getProcedure

public List<ExplanationOfBenefit.ProcedureComponent> getProcedure()

Returns:

procedure (Procedures performed on the patient relevant to the billing items with the claim.)

setProcedure

public ExplanationOfBenefit setProcedure(List<ExplanationOfBenefit.ProcedureComponent> theProcedure)

Returns:

Returns a reference to this for easy method chaining

hasProcedure

public boolean hasProcedure()

addProcedure

public ExplanationOfBenefit.ProcedureComponent addProcedure()

addProcedure

public ExplanationOfBenefit addProcedure(ExplanationOfBenefit.ProcedureComponent t)

getProcedureFirstRep

public ExplanationOfBenefit.ProcedureComponent getProcedureFirstRep()

Returns:

The first repetition of repeating field procedure, creating it if it does not already exist {3}

getPrecedenceElement

public PositiveIntType getPrecedenceElement()

Returns:

precedence (This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.). This is the underlying object with id, value and extensions. The accessor "getPrecedence" gives direct access to the value

hasPrecedenceElement

public boolean hasPrecedenceElement()

hasPrecedence

public boolean hasPrecedence()

setPrecedenceElement

public ExplanationOfBenefit setPrecedenceElement(PositiveIntType value)

Parameters:

value - precedence (This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.). This is the underlying object with id, value and extensions. The accessor "getPrecedence" gives direct access to the value

getPrecedence

public int getPrecedence()

Returns:

This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

setPrecedence

public ExplanationOfBenefit setPrecedence(int value)

Parameters:

value - This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

getInsurance

public List<ExplanationOfBenefit.InsuranceComponent> getInsurance()

Returns:

insurance (Financial instruments for reimbursement for the health care products and services specified on the claim.)

setInsurance

public ExplanationOfBenefit setInsurance(List<ExplanationOfBenefit.InsuranceComponent> theInsurance)

Returns:

Returns a reference to this for easy method chaining

hasInsurance

public boolean hasInsurance()

addInsurance

public ExplanationOfBenefit.InsuranceComponent addInsurance()

addInsurance

public ExplanationOfBenefit addInsurance(ExplanationOfBenefit.InsuranceComponent t)

getInsuranceFirstRep

public ExplanationOfBenefit.InsuranceComponent getInsuranceFirstRep()

Returns:

The first repetition of repeating field insurance, creating it if it does not already exist {3}

getAccident

public ExplanationOfBenefit.AccidentComponent getAccident()

Returns:

accident (Details of a accident which resulted in injuries which required the products and services listed in the claim.)

hasAccident

public boolean hasAccident()

setAccident

public ExplanationOfBenefit setAccident(ExplanationOfBenefit.AccidentComponent value)

Parameters:

value - accident (Details of a accident which resulted in injuries which required the products and services listed in the claim.)

getPatientPaid

public Money getPatientPaid()

Returns:

patientPaid (The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)

hasPatientPaid

public boolean hasPatientPaid()

setPatientPaid

public ExplanationOfBenefit setPatientPaid(Money value)

Parameters:

value - patientPaid (The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)

getItem

public List<ExplanationOfBenefit.ItemComponent> getItem()

Returns:

item (A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.)

setItem

public ExplanationOfBenefit setItem(List<ExplanationOfBenefit.ItemComponent> theItem)

Returns:

Returns a reference to this for easy method chaining

hasItem

public boolean hasItem()

addItem

public ExplanationOfBenefit.ItemComponent addItem()

addItem

public ExplanationOfBenefit addItem(ExplanationOfBenefit.ItemComponent t)

getItemFirstRep

public ExplanationOfBenefit.ItemComponent getItemFirstRep()

Returns:

The first repetition of repeating field item, creating it if it does not already exist {3}

getAddItem

public List<ExplanationOfBenefit.AddedItemComponent> getAddItem()

Returns:

addItem (The first-tier service adjudications for payor added product or service lines.)

setAddItem

public ExplanationOfBenefit setAddItem(List<ExplanationOfBenefit.AddedItemComponent> theAddItem)

Returns:

Returns a reference to this for easy method chaining

hasAddItem

public boolean hasAddItem()

addAddItem

public ExplanationOfBenefit.AddedItemComponent addAddItem()

addAddItem

public ExplanationOfBenefit addAddItem(ExplanationOfBenefit.AddedItemComponent t)

getAddItemFirstRep

public ExplanationOfBenefit.AddedItemComponent getAddItemFirstRep()

Returns:

The first repetition of repeating field addItem, creating it if it does not already exist {3}

getAdjudication

public List<ExplanationOfBenefit.AdjudicationComponent> getAdjudication()

Returns:

adjudication (The adjudication results which are presented at the header level rather than at the line-item or add-item levels.)

setAdjudication

public ExplanationOfBenefit setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication)

Returns:

Returns a reference to this for easy method chaining

hasAdjudication

public boolean hasAdjudication()

addAdjudication

public ExplanationOfBenefit.AdjudicationComponent addAdjudication()

addAdjudication

public ExplanationOfBenefit addAdjudication(ExplanationOfBenefit.AdjudicationComponent t)

getAdjudicationFirstRep

public ExplanationOfBenefit.AdjudicationComponent getAdjudicationFirstRep()

Returns:

The first repetition of repeating field adjudication, creating it if it does not already exist {3}

getTotal

public List<ExplanationOfBenefit.TotalComponent> getTotal()

Returns:

total (Categorized monetary totals for the adjudication.)

setTotal

public ExplanationOfBenefit setTotal(List<ExplanationOfBenefit.TotalComponent> theTotal)

Returns:

Returns a reference to this for easy method chaining

hasTotal

public boolean hasTotal()

addTotal

public ExplanationOfBenefit.TotalComponent addTotal()

addTotal

public ExplanationOfBenefit addTotal(ExplanationOfBenefit.TotalComponent t)

getTotalFirstRep

public ExplanationOfBenefit.TotalComponent getTotalFirstRep()

Returns:

The first repetition of repeating field total, creating it if it does not already exist {3}

getPayment

public ExplanationOfBenefit.PaymentComponent getPayment()

Returns:

payment (Payment details for the adjudication of the claim.)

hasPayment

public boolean hasPayment()

setPayment

public ExplanationOfBenefit setPayment(ExplanationOfBenefit.PaymentComponent value)

Parameters:

value - payment (Payment details for the adjudication of the claim.)

getFormCode

public CodeableConcept getFormCode()

Returns:

formCode (A code for the form to be used for printing the content.)

hasFormCode

public boolean hasFormCode()

setFormCode

public ExplanationOfBenefit setFormCode(CodeableConcept value)

Parameters:

value - formCode (A code for the form to be used for printing the content.)

getForm

public Attachment getForm()

Returns:

form (The actual form, by reference or inclusion, for printing the content or an EOB.)

hasForm

public boolean hasForm()

setForm

public ExplanationOfBenefit setForm(Attachment value)

Parameters:

value - form (The actual form, by reference or inclusion, for printing the content or an EOB.)

getProcessNote

public List<ExplanationOfBenefit.NoteComponent> getProcessNote()

Returns:

processNote (A note that describes or explains adjudication results in a human readable form.)

setProcessNote

public ExplanationOfBenefit setProcessNote(List<ExplanationOfBenefit.NoteComponent> theProcessNote)

Returns:

Returns a reference to this for easy method chaining

hasProcessNote

public boolean hasProcessNote()

addProcessNote

public ExplanationOfBenefit.NoteComponent addProcessNote()

addProcessNote

public ExplanationOfBenefit addProcessNote(ExplanationOfBenefit.NoteComponent t)

getProcessNoteFirstRep

public ExplanationOfBenefit.NoteComponent getProcessNoteFirstRep()

Returns:

The first repetition of repeating field processNote, creating it if it does not already exist {3}

getBenefitPeriod

public Period getBenefitPeriod()

Returns:

benefitPeriod (The term of the benefits documented in this response.)

hasBenefitPeriod

public boolean hasBenefitPeriod()

setBenefitPeriod

public ExplanationOfBenefit setBenefitPeriod(Period value)

Parameters:

value - benefitPeriod (The term of the benefits documented in this response.)

getBenefitBalance

public List<ExplanationOfBenefit.BenefitBalanceComponent> getBenefitBalance()

Returns:

benefitBalance (Balance by Benefit Category.)

setBenefitBalance

public ExplanationOfBenefit setBenefitBalance(List<ExplanationOfBenefit.BenefitBalanceComponent> theBenefitBalance)

Returns:

Returns a reference to this for easy method chaining

hasBenefitBalance

public boolean hasBenefitBalance()

addBenefitBalance

public ExplanationOfBenefit.BenefitBalanceComponent addBenefitBalance()

addBenefitBalance

public ExplanationOfBenefit addBenefitBalance(ExplanationOfBenefit.BenefitBalanceComponent t)

getBenefitBalanceFirstRep

public ExplanationOfBenefit.BenefitBalanceComponent getBenefitBalanceFirstRep()

Returns:

The first repetition of repeating field benefitBalance, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public ExplanationOfBenefit copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(ExplanationOfBenefit dst)

typedCopy

protected ExplanationOfBenefit typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource