Release 5 Ballot
FinancialThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Financial Management Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for ExplanationOfBenefit, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ExplanationOfBenefit",
"$ref": "#/definitions/ExplanationOfBenefit",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ExplanationOfBenefit": {
"description": "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.",
"properties": {
"resourceType": {
"description": "This is a ExplanationOfBenefit resource",
"const": "ExplanationOfBenefit"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "A unique identifier assigned to this explanation of benefit.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "The status of the resource instance.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subType": {
"description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"use": {
"description": "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 \u0027what if\u0027 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.",
"$ref": "#/definitions/code"
},
"_use": {
"description": "Extensions for use",
"$ref": "Element.schema.json#/definitions/Element"
},
"patient": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"billablePeriod": {
"description": "The period for which charges are being submitted.",
"$ref": "Period.schema.json#/definitions/Period"
},
"created": {
"description": "The date this resource was created.",
"$ref": "#/definitions/dateTime"
},
"_created": {
"description": "Extensions for created",
"$ref": "Element.schema.json#/definitions/Element"
},
"enterer": {
"description": "Individual who created the claim, predetermination or preauthorization.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"insurer": {
"description": "The party responsible for authorization, adjudication and reimbursement.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"provider": {
"description": "The provider which is responsible for the claim, predetermination or preauthorization.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"priority": {
"description": "The provider-required urgency of processing the request. Typical values include: stat, normal deferred.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"fundsReserveRequested": {
"description": "A code to indicate whether and for whom funds are to be reserved for future claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"fundsReserve": {
"description": "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"related": {
"description": "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Related"
},
"type": "array"
},
"prescription": {
"description": "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 \u0027order\u0027 for oxygen or wheelchair or physiotherapy treatments.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"originalPrescription": {
"description": "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"payee": {
"description": "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"$ref": "#/definitions/ExplanationOfBenefit_Payee"
},
"referral": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"encounter": {
"description": "A billed item may include goods or services provided in multiple encounters.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"facility": {
"description": "Facility where the services were provided.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"claim": {
"description": "The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"claimResponse": {
"description": "The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"outcome": {
"description": "The outcome of the claim, predetermination, or preauthorization processing.",
"$ref": "#/definitions/code"
},
"_outcome": {
"description": "Extensions for outcome",
"$ref": "Element.schema.json#/definitions/Element"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"disposition": {
"description": "A human readable description of the status of the adjudication.",
"$ref": "#/definitions/string"
},
"_disposition": {
"description": "Extensions for disposition",
"$ref": "Element.schema.json#/definitions/Element"
},
"preAuthRef": {
"description": "Reference from the Insurer which is used in later communications which refers to this adjudication.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_preAuthRef": {
"description": "Extensions for preAuthRef",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"preAuthRefPeriod": {
"description": "The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.",
"items": {
"$ref": "Period.schema.json#/definitions/Period"
},
"type": "array"
},
"diagnosisRelatedGroup": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"careTeam": {
"description": "The members of the team who provided the products and services.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_CareTeam"
},
"type": "array"
},
"supportingInfo": {
"description": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_SupportingInfo"
},
"type": "array"
},
"diagnosis": {
"description": "Information about diagnoses relevant to the claim items.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Diagnosis"
},
"type": "array"
},
"procedure": {
"description": "Procedures performed on the patient relevant to the billing items with the claim.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Procedure"
},
"type": "array"
},
"precedence": {
"description": "This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.",
"$ref": "#/definitions/positiveInt"
},
"_precedence": {
"description": "Extensions for precedence",
"$ref": "Element.schema.json#/definitions/Element"
},
"insurance": {
"description": "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Insurance"
},
"type": "array"
},
"accident": {
"description": "Details of a accident which resulted in injuries which required the products and services listed in the claim.",
"$ref": "#/definitions/ExplanationOfBenefit_Accident"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"item": {
"description": "A claim line. Either a simple (a product or service) or a \u0027group\u0027 of details which can also be a simple items or groups of sub-details.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Item"
},
"type": "array"
},
"addItem": {
"description": "The first-tier service adjudications for payor added product or service lines.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_AddItem"
},
"type": "array"
},
"adjudication": {
"description": "The adjudication results which are presented at the header level rather than at the line-item or add-item levels.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
},
"total": {
"description": "Categorized monetary totals for the adjudication.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Total"
},
"type": "array"
},
"payment": {
"description": "Payment details for the adjudication of the claim.",
"$ref": "#/definitions/ExplanationOfBenefit_Payment"
},
"formCode": {
"description": "A code for the form to be used for printing the content.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"form": {
"description": "The actual form, by reference or inclusion, for printing the content or an EOB.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"processNote": {
"description": "A note that describes or explains adjudication results in a human readable form.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_ProcessNote"
},
"type": "array"
},
"benefitPeriod": {
"description": "The term of the benefits documented in this response.",
"$ref": "Period.schema.json#/definitions/Period"
},
"benefitBalance": {
"description": "Balance by Benefit Category.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_BenefitBalance"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"patient",
"type",
"resourceType"
]
},
"ExplanationOfBenefit_Related": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"claim": {
"description": "Reference to a related claim.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"relationship": {
"description": "A code to convey how the claims are related.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"reference": {
"description": "An alternate organizational reference to the case or file to which this particular claim pertains.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_Payee": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Type of Party to be reimbursed: Subscriber, provider, other.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"party": {
"description": "Reference to the individual or organization to whom any payment will be made.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_CareTeam": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A number to uniquely identify care team entries.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"provider": {
"description": "Member of the team who provided the product or service.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"responsible": {
"description": "The party who is billing and/or responsible for the claimed products or services.",
"$ref": "#/definitions/boolean"
},
"_responsible": {
"description": "Extensions for responsible",
"$ref": "Element.schema.json#/definitions/Element"
},
"role": {
"description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"specialty": {
"description": "The specialization of the practitioner or provider which is applicable for this service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"provider"
]
},
"ExplanationOfBenefit_SupportingInfo": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A number to uniquely identify supporting information entries.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"code": {
"description": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"timingDate": {
"description": "The date when or period to which this information refers.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_timingDate": {
"description": "Extensions for timingDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"timingPeriod": {
"description": "The date when or period to which this information refers.",
"$ref": "Period.schema.json#/definitions/Period"
},
"valueBoolean": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueQuantity": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueAttachment": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"valueReference": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"valueIdentifier": {
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"reason": {
"description": "Provides the reason in the situation where a reason code is required in addition to the content.",
"$ref": "Coding.schema.json#/definitions/Coding"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"category"
]
},
"ExplanationOfBenefit_Diagnosis": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A number to uniquely identify diagnosis entries.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"diagnosisCodeableConcept": {
"description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"diagnosisReference": {
"description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": {
"description": "When the condition was observed or the relative ranking.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"onAdmission": {
"description": "Indication of whether the diagnosis was present on admission to a facility.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_Procedure": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A number to uniquely identify procedure entries.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "When the condition was observed or the relative ranking.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"date": {
"description": "Date and optionally time the procedure was performed.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"procedureCodeableConcept": {
"description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"procedureReference": {
"description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"udi": {
"description": "Unique Device Identifiers associated with this line item.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_Insurance": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"focal": {
"description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"$ref": "#/definitions/boolean"
},
"_focal": {
"description": "Extensions for focal",
"$ref": "Element.schema.json#/definitions/Element"
},
"coverage": {
"description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"preAuthRef": {
"description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_preAuthRef": {
"description": "Extensions for preAuthRef",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"coverage"
]
},
"ExplanationOfBenefit_Accident": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"date": {
"description": "Date of an accident event related to the products and services contained in the claim.",
"$ref": "#/definitions/date"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"locationAddress": {
"description": "The physical location of the accident event.",
"$ref": "Address.schema.json#/definitions/Address"
},
"locationReference": {
"description": "The physical location of the accident event.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_Item": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A number to uniquely identify item entries.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"careTeamSequence": {
"description": "Care team members related to this service or product.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_careTeamSequence": {
"description": "Extensions for careTeamSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"diagnosisSequence": {
"description": "Diagnoses applicable for this service or product.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_diagnosisSequence": {
"description": "Extensions for diagnosisSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"procedureSequence": {
"description": "Procedures applicable for this service or product.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_procedureSequence": {
"description": "Extensions for procedureSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"informationSequence": {
"description": "Exceptions, special conditions and supporting information applicable for this service or product.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_informationSequence": {
"description": "Extensions for informationSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"category": {
"description": "Code to identify the general type of benefits under which products and services are provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"programCode": {
"description": "Identifies the program under which this may be recovered.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"servicedDate": {
"description": "The date or dates when the service or product was supplied, performed or completed.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_servicedDate": {
"description": "Extensions for servicedDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"servicedPeriod": {
"description": "The date or dates when the service or product was supplied, performed or completed.",
"$ref": "Period.schema.json#/definitions/Period"
},
"locationCodeableConcept": {
"description": "Where the product or service was provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"locationAddress": {
"description": "Where the product or service was provided.",
"$ref": "Address.schema.json#/definitions/Address"
},
"locationReference": {
"description": "Where the product or service was provided.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"udi": {
"description": "Unique Device Identifiers associated with this line item.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"bodySite": {
"description": "Physical location where the service is performed or applies.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_BodySite"
},
"type": "array"
},
"encounter": {
"description": "A billed item may include goods or services provided in multiple encounters.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
},
"detail": {
"description": "Second-tier of goods and services.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Detail"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_BodySite": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"site": {
"description": "Physical service site on the patient (limb, tooth, etc.).",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"subSite": {
"description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"site"
]
},
"ExplanationOfBenefit_Adjudication": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"category": {
"description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"reason": {
"description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"amount": {
"description": "Monetary amount associated with the category.",
"$ref": "Money.schema.json#/definitions/Money"
},
"value": {
"description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above.",
"$ref": "#/definitions/decimal"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"category"
]
},
"ExplanationOfBenefit_Detail": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"category": {
"description": "Code to identify the general type of benefits under which products and services are provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"programCode": {
"description": "Identifies the program under which this may be recovered.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"udi": {
"description": "Unique Device Identifiers associated with this line item.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "The adjudication results.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
},
"subDetail": {
"description": "Third-tier of goods and services.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_SubDetail"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_SubDetail": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"sequence": {
"description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.",
"$ref": "#/definitions/positiveInt"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"category": {
"description": "Code to identify the general type of benefits under which products and services are provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"programCode": {
"description": "Identifies the program under which this may be recovered.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"udi": {
"description": "Unique Device Identifiers associated with this line item.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "The adjudication results.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_AddItem": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"itemSequence": {
"description": "Claim items which this service line is intended to replace.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_itemSequence": {
"description": "Extensions for itemSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"detailSequence": {
"description": "The sequence number of the details within the claim item which this line is intended to replace.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_detailSequence": {
"description": "Extensions for detailSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"subDetailSequence": {
"description": "The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_subDetailSequence": {
"description": "Extensions for subDetailSequence",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"provider": {
"description": "The providers who are authorized for the services rendered to the patient.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"programCode": {
"description": "Identifies the program under which this may be recovered.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"servicedDate": {
"description": "The date or dates when the service or product was supplied, performed or completed.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_servicedDate": {
"description": "Extensions for servicedDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"servicedPeriod": {
"description": "The date or dates when the service or product was supplied, performed or completed.",
"$ref": "Period.schema.json#/definitions/Period"
},
"locationCodeableConcept": {
"description": "Where the product or service was provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"locationAddress": {
"description": "Where the product or service was provided.",
"$ref": "Address.schema.json#/definitions/Address"
},
"locationReference": {
"description": "Where the product or service was provided.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"bodySite": {
"description": "Physical location where the service is performed or applies.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_BodySite1"
},
"type": "array"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "The adjudication results.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
},
"detail": {
"description": "The second-tier service adjudications for payor added services.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Detail1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_BodySite1": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"site": {
"description": "Physical service site on the patient (limb, tooth, etc.).",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"subSite": {
"description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"site"
]
},
"ExplanationOfBenefit_Detail1": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "The adjudication results.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
},
"subDetail": {
"description": "The third-tier service adjudications for payor added services.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_SubDetail1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_SubDetail1": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"revenue": {
"description": "The type of revenue or cost center providing the product and/or service.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrService": {
"description": "When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"productOrServiceEnd": {
"description": "This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"modifier": {
"description": "Item typification or modifiers codes to convey additional context for the product or service.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"patientPaid": {
"description": "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.",
"$ref": "Money.schema.json#/definitions/Money"
},
"quantity": {
"description": "The number of repetitions of a service or product.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"unitPrice": {
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"$ref": "Money.schema.json#/definitions/Money"
},
"factor": {
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"$ref": "#/definitions/decimal"
},
"_factor": {
"description": "Extensions for factor",
"$ref": "Element.schema.json#/definitions/Element"
},
"tax": {
"description": "The total of taxes applicable for this product or service.",
"$ref": "Money.schema.json#/definitions/Money"
},
"net": {
"description": "The quantity times the unit price for an additional service or product or charge.",
"$ref": "Money.schema.json#/definitions/Money"
},
"noteNumber": {
"description": "The numbers associated with notes below which apply to the adjudication of this item.",
"items": {
"$ref": "#/definitions/positiveInt"
},
"type": "array"
},
"_noteNumber": {
"description": "Extensions for noteNumber",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"decision": {
"description": "The result of the claim, predetermination, or preauthorization adjudication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjudication": {
"description": "The adjudication results.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Adjudication"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_Total": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"category": {
"description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"amount": {
"description": "Monetary total amount associated with the category.",
"$ref": "Money.schema.json#/definitions/Money"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"category"
]
},
"ExplanationOfBenefit_Payment": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Whether this represents partial or complete payment of the benefits payable.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"adjustment": {
"description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim\u0027s adjudication.",
"$ref": "Money.schema.json#/definitions/Money"
},
"adjustmentReason": {
"description": "Reason for the payment adjustment.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"date": {
"description": "Estimated date the payment will be issued or the actual issue date of payment.",
"$ref": "#/definitions/date"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"amount": {
"description": "Benefits payable less any payment adjustment.",
"$ref": "Money.schema.json#/definitions/Money"
},
"identifier": {
"description": "Issuer\u0027s unique identifier for the payment instrument.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_ProcessNote": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"number": {
"description": "A number to uniquely identify a note entry.",
"$ref": "#/definitions/positiveInt"
},
"_number": {
"description": "Extensions for number",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The business purpose of the note text.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "The explanation or description associated with the processing.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "A code to define the language used in the text of the note.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"ExplanationOfBenefit_BenefitBalance": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"category": {
"description": "Code to identify the general type of benefits under which products and services are provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"excluded": {
"description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.",
"$ref": "#/definitions/boolean"
},
"_excluded": {
"description": "Extensions for excluded",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "A short name or tag for the benefit.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A richer description of the benefit or services covered.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"network": {
"description": "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"unit": {
"description": "Indicates if the benefits apply to an individual or to the family.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"term": {
"description": "The term or period of the values such as \u0027maximum lifetime benefit\u0027 or \u0027maximum annual visits\u0027.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"financial": {
"description": "Benefits Used to date.",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit_Financial"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"category"
]
},
"ExplanationOfBenefit_Financial": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Classification of benefit being provided.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"allowedUnsignedInt": {
"description": "The quantity of the benefit which is permitted under the coverage.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_allowedUnsignedInt": {
"description": "Extensions for allowedUnsignedInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"allowedString": {
"description": "The quantity of the benefit which is permitted under the coverage.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_allowedString": {
"description": "Extensions for allowedString",
"$ref": "Element.schema.json#/definitions/Element"
},
"allowedMoney": {
"description": "The quantity of the benefit which is permitted under the coverage.",
"$ref": "Money.schema.json#/definitions/Money"
},
"usedUnsignedInt": {
"description": "The quantity of the benefit which have been consumed to date.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_usedUnsignedInt": {
"description": "Extensions for usedUnsignedInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"usedMoney": {
"description": "The quantity of the benefit which have been consumed to date.",
"$ref": "Money.schema.json#/definitions/Money"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"type"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:08+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change