ExplanationOfBenefit

class ExplanationOfBenefit(val id: Option[String], val use: CLAIM_USE, val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val form: Option[Attachment], val claim: Option[Reference], val status: EXPLANATIONOFBENEFIT_STATUS, val subType: Option[CodeableConcept], val patient: Reference, val created: FHIRDateTime, val enterer: Option[Reference], val insurer: Reference, val outcome: REMITTANCE_OUTCOME, val language: Option[LANGUAGES], val provider: Reference, val priority: Option[CodeableConcept], val referral: Option[Reference], val facility: Option[Reference], val formCode: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val preAuthRef: LitSeq[String], val precedence: Option[PositiveInt], val disposition: Option[String], val fundsReserve: Option[CodeableConcept], val prescription: Option[Reference], val adjudication: LitSeq[Adjudication], val implicitRules: Option[UriStr], val claimResponse: Option[Reference], val benefitPeriod: Option[Period], val billablePeriod: Option[Period], val preAuthRefPeriod: LitSeq[Period], val modifierExtension: LitSeq[Extension], val originalPrescription: Option[Reference], val fundsReserveRequested: Option[CodeableConcept], val payee: Option[Payee], val total: LitSeq[Total], val related: LitSeq[Related], val payment: Option[Payment], val careTeam: LitSeq[CareTeam], val accident: Option[Accident], val diagnosis: LitSeq[Diagnosis], val procedure: LitSeq[Procedure], val insurance: NonEmptyLitSeq[Insurance], val processNote: LitSeq[ProcessNote], val supportingInfo: LitSeq[SupportingInfo], val item: LitSeq[Item], val addItem: LitSeq[AddItem], val benefitBalance: LitSeq[BenefitBalance], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) 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.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
accident
  • Details of a accident which resulted in injuries which required the products and services listed in the claim.
addItem
  • The first-tier service adjudications for payor added product or service lines.
adjudication
  • The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
benefitBalance
  • Balance by Benefit Category.
benefitPeriod
  • The term of the benefits documented in this response.
billablePeriod
  • The period for which charges are being submitted.
careTeam
  • The members of the team who provided the products and services.
claim
  • The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
claimResponse
  • The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
diagnosis
  • Information about diagnoses relevant to the claim items.
disposition
  • A human readable description of the status of the adjudication.
enterer
  • Individual who created the claim, predetermination or preauthorization.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
facility
  • Facility where the services were provided.
form
  • The actual form, by reference or inclusion, for printing the content or an EOB.
formCode
  • A code for the form to be used for printing the content.
fundsReserve
  • A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
fundsReserveRequested
  • A code to indicate whether and for whom funds are to be reserved for future claims.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this explanation of benefit.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services specified on the claim.
insurer
  • The party responsible for authorization, adjudication and reimbursement.
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.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
originalPrescription
  • Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
outcome
  • The outcome of the claim, predetermination, or preauthorization processing.
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.
payee
  • The party to be reimbursed for cost of the products and services according to the terms of the policy.
payment
  • Payment details for the adjudication of the claim.
preAuthRef
  • Reference from the Insurer which is used in later communications which refers to this adjudication.
preAuthRefPeriod
  • The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
precedence
  • This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
prescription
  • Prescription to support the dispensing of pharmacy, device or vision products.
priority
  • The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
procedure
  • Procedures performed on the patient relevant to the billing items with the claim.
processNote
  • A note that describes or explains adjudication results in a human readable form.
provider
  • The provider which is responsible for the claim, predetermination or preauthorization.
referral
  • A reference to a referral resource.
related
  • Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
status
  • The status of the resource instance.
subType
  • A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
supportingInfo
  • Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
total
  • Categorized monetary totals for the adjudication.
use
  • A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
Constructor:

Introduces the fields use, type, form, claim, status, subType, patient, created, enterer, insurer, outcome, provider, priority, referral, facility, formCode, identifier, preAuthRef, precedence, disposition, fundsReserve, prescription, adjudication, claimResponse, benefitPeriod, billablePeriod, preAuthRefPeriod, originalPrescription, fundsReserveRequested, payee, total, related, payment, careTeam, accident, diagnosis, procedure, insurance, processNote, supportingInfo, item, addItem, benefitBalance.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): FHIRObject.this.type

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[FHIRObject]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: ExplanationOfBenefit <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: ExplanationOfBenefit <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): FHIRObject.this.type

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: ExplanationOfBenefit <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: ExplanationOfBenefit <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject
def withField[T : LTag, Up >: ExplanationOfBenefit <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: ExplanationOfBenefit <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: ExplanationOfBenefit <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject

Concrete fields

val `type`: CodeableConcept
val accident: Option[Accident]
val addItem: LitSeq[AddItem]
val benefitPeriod: Option[Period]
val billablePeriod: Option[Period]
val careTeam: LitSeq[CareTeam]
val claim: Option[Reference]
val claimResponse: Option[Reference]
override val contained: LitSeq[Resource]
val created: FHIRDateTime
val diagnosis: LitSeq[Diagnosis]
val disposition: Option[String]
val enterer: Option[Reference]
override val extension: LitSeq[Extension]
val facility: Option[Reference]
val form: Option[Attachment]
val formCode: Option[CodeableConcept]
val fundsReserve: Option[CodeableConcept]
val fundsReserveRequested: Option[CodeableConcept]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val insurance: NonEmptyLitSeq[Insurance]
val insurer: Reference
val item: LitSeq[Item]
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val originalPrescription: Option[Reference]
val patient: Reference
val payee: Option[Payee]
val payment: Option[Payment]
val preAuthRef: LitSeq[String]
val preAuthRefPeriod: LitSeq[Period]
val precedence: Option[PositiveInt]
val prescription: Option[Reference]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val priority: Option[CodeableConcept]
val procedure: LitSeq[Procedure]
val provider: Reference
val referral: Option[Reference]
val subType: Option[CodeableConcept]
override val text: Option[Narrative]
override val thisTypeName: String
val total: LitSeq[Total]

Inherited fields

val companion: CompanionFor[ExplanationOfBenefit]
Inherited from:
FHIRObject