2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

7.9.4 Resource OralHealthClaim - Detailed Descriptions

Detailed Descriptions for the elements in the OralHealthClaim resource.

OralHealthClaim
Definition

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

Control1..1
OralHealthClaim.identifier
Definition

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

Control0..*
TypeIdentifier
OralHealthClaim.ruleset
Definition

The version of the specification on which this instance relies.

Control0..1
BindingRuleset: Example: See http://hl7.org/fhir/vs/ruleset (The static and dynamic model to which contents conform, may be business version or standard and version.)
TypeCoding
Alternate NamesBusinessVersion
OralHealthClaim.originalRuleset
Definition

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

Control0..1
BindingRuleset: Example: See http://hl7.org/fhir/vs/ruleset (The static and dynamic model to which contents conform, may be business version or standard and version.)
TypeCoding
Alternate NamesOriginalBusinessVersion
OralHealthClaim.created
Definition

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

Control0..1
TypedateTime
OralHealthClaim.target
Definition

Insurer Identifier, typical BIN number (6 digit).

Control0..1
TypeReference(Organization)
OralHealthClaim.provider
Definition

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

Control0..1
TypeReference(Practitioner)
OralHealthClaim.organization
Definition

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

Control0..1
TypeReference(Organization)
OralHealthClaim.use
Definition

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

Control0..1
BindingUse: Required: http://hl7.org/fhir/use-link (Complete, proposed, exploratory, other)
Typecode
OralHealthClaim.priority
Definition

Immediate (STAT), best effort (NORMAL), deferred (DEFER).

Control0..1
BindingProcessPriority: Example: See http://hl7.org/fhir/vs/process-priority (The timeliness with which processing is required: STAT, normal, Deferred)
TypeCoding
OralHealthClaim.fundsReserve
Definition

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

Control0..1
BindingFundsReserve: Example: See http://hl7.org/fhir/vs/fundsreserve (For whom funds are to be reserved: (Patient, Provider, None))
TypeCoding
OralHealthClaim.enterer
Definition

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

Control0..1
TypeReference(Practitioner)
OralHealthClaim.facility
Definition

Facility where the services were provided.

Control0..1
TypeReference(Location)
OralHealthClaim.payee
Definition

The party to be reimbursed for the services.

Control0..1
OralHealthClaim.payee.type
Definition

Party to be reimbursed: Subscriber, provider, other.

Control0..1
BindingPayeeType: Example: See http://hl7.org/fhir/vs/payeetype (A code for the party to be reimbursed.)
TypeCoding
OralHealthClaim.payee.provider
Definition

The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned).

Control0..1
TypeReference(Practitioner)
OralHealthClaim.payee.organization
Definition

The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned).

Control0..1
TypeReference(Organization)
OralHealthClaim.payee.person
Definition

The person other than the subscriber who is to be reimbursed for the claim (the party to whom any benefit is assigned).

Control0..1
TypeReference(Patient)
OralHealthClaim.referral
Definition

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

Control0..1
TypeReference(ReferralRequest)
OralHealthClaim.diagnosis
Definition

Ordered list of patient diagnosis for which care is sought.

Control0..*
OralHealthClaim.diagnosis.sequence
Definition

Sequence of diagnosis.

Control1..1
Typeinteger
Requirements

Required to maintain order of the diagnoses.

OralHealthClaim.diagnosis.diagnosis
Definition

The diagnosis.

Control1..1
BindingICD10: Example: See http://hl7.org/fhir/vs/icd-10 (ICD10 Diagnostic codes)
TypeCoding
Requirements

Required to adjudicate services rendered to condition presented.

OralHealthClaim.condition
Definition

List of patient conditions for which care is sought.

Control0..*
BindingConditions: Example: See http://hl7.org/fhir/vs/fm-conditions (Patient conditions and symptoms)
TypeCoding
OralHealthClaim.patient
Definition

Patient Resource.

Control1..1
TypeReference(Patient)
OralHealthClaim.coverage
Definition

Financial instrument by which payment information for health care.

Control0..*
Requirements

Health care programs and insurers are significant payors of health service costs.

OralHealthClaim.coverage.sequence
Definition

A service line item.

Control1..1
Typeinteger
Requirements

To maintain order of the coverages.

OralHealthClaim.coverage.focal
Definition

The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.

Control1..1
Typeboolean
Requirements

To identify which coverage is being adjudicated.

OralHealthClaim.coverage.coverage
Definition

Reference to the program or plan identification, underwriter or payor.

Control1..1
TypeReference(Coverage)
Requirements

Need to identify the issuer to target for processing and for coordination of benefit processing.

OralHealthClaim.coverage.businessArrangement
Definition

The contract number of a business agreement which describes the terms and conditions.

Control0..1
Typestring
OralHealthClaim.coverage.relationship
Definition

The relationship of the patient to the subscriber.

Control1..1
BindingRelationship: Example: See http://hl7.org/fhir/vs/relationship (The code for the relationship of the patient to the subscriber)
TypeCoding
Requirements

To determine relationship between the patient and the subscriber.

OralHealthClaim.coverage.preauthref
Definition

A list of references from the Insurer to which these services pertain.

Control0..*
Typestring
Requirements

To provide any pre=determination or prior authorization reference.

OralHealthClaim.coverage.claimResponse
Definition

The Coverages adjudication details.

Control0..1
TypeReference(ClaimResponse)
Requirements

Used by downstream payers to determine what balance remains and the net payable.

OralHealthClaim.coverage.originalRuleset
Definition

The style (standard) and version of the original material which was converted into this resource.

Control0..1
BindingRuleset: Example: See http://hl7.org/fhir/vs/ruleset (The static and dynamic model to which contents conform, may be business version or standard and version.)
TypeCoding
Requirements

Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.

OralHealthClaim.exception
Definition

Factors which may influence the applicability of coverage.

Control0..*
BindingException: Example: See http://hl7.org/fhir/vs/exception (The eligibility exception codes.)
TypeCoding
Requirements

To determine extenuating circumstances for coverage.

OralHealthClaim.school
Definition

Name of school for over-aged dependants.

Control0..1
Typestring
Requirements

Often required for over-age dependents.

OralHealthClaim.accident
Definition

Date of an accident which these services are addressing.

Control0..1
Typedate
Requirements

Coverage may be dependant on accidents.

OralHealthClaim.accidentType
Definition

Type of accident: work, auto, etc.

Control0..1
BindingAccidentType: Example: See http://hl7.org/fhir/vs/ActIncidentCode (Type of accident: work place, auto, etc.)
TypeCoding
Requirements

Coverage may be dependant on the type of accident.

OralHealthClaim.interventionException
Definition

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

Control0..*
BindingIntervention: Example: See http://hl7.org/fhir/vs/intervention (Intervention and exception codes (Pharm))
TypeCoding
Requirements

Coverage may be modified based on exception information provided.

OralHealthClaim.missingteeth
Definition

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

Control0..*
Requirements

The list of missing teeth may influence the adjudication of services for example with Bridges.

OralHealthClaim.missingteeth.tooth
Definition

The code identifying which tooth is missing.

Control1..1
BindingTooth: Example: See http://hl7.org/fhir/vs/teeth (The codes for the teeth, subset of OralSites)
TypeCoding
Requirements

Provides the tooth number of the missing tooth.

OralHealthClaim.missingteeth.reason
Definition

Missing reason may be: E-extraction, O-other.

Control0..1
BindingMissingReason: Example: See http://hl7.org/fhir/vs/missing-tooth-reason (Reason codes for the missing teeth)
TypeCoding
Requirements

Provides the reason for the missing tooth.

OralHealthClaim.missingteeth.extractiondate
Definition

The date of the extraction either known from records or patient reported estimate.

Control0..1
Typedate
Requirements

Some services and adjudications require this information.

OralHealthClaim.orthoPlan
Definition

The high-level details of an Orthodontic Treatment Plan.

Control0..1
Requirements

Provides an overall Oththodonic treatment plan.

OralHealthClaim.orthoPlan.start
Definition

The intended start date for service.

Control0..1
Typedate
OralHealthClaim.orthoPlan.examFee
Definition

The estimated first examination fee.

Control0..1
TypeMoney
OralHealthClaim.orthoPlan.diagnosticFee
Definition

The estimated diagnostic fee.

Control0..1
TypeMoney
OralHealthClaim.orthoPlan.initialPayment
Definition

The estimated initial payment.

Control0..1
TypeMoney
OralHealthClaim.orthoPlan.durationMonths
Definition

The estimated treatment duration in months.

Control0..1
Typeinteger
OralHealthClaim.orthoPlan.paymentCount
Definition

The anticipated number of payments.

Control0..1
Typeinteger
OralHealthClaim.orthoPlan.periodicPayment
Definition

The anticipated payment amount.

Control0..1
TypeMoney
OralHealthClaim.item
Definition

First tier of goods and services.

Control0..*
OralHealthClaim.item.sequence
Definition

A service line number.

Control1..1
Typeinteger
OralHealthClaim.item.type
Definition

The type of product or service.

Control1..1
BindingItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.)
TypeCoding
OralHealthClaim.item.provider
Definition

The practitioner who is responsible for the services rendered to the patient.

Control0..1
TypeReference(Practitioner)
OralHealthClaim.item.diagnosisLinkId
Definition

Diagnosis applicable for this service or product line.

Control0..*
Typeinteger
OralHealthClaim.item.service
Definition

If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.

Control1..1
BindingServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes)
TypeCoding
OralHealthClaim.item.serviceDate
Definition

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

Control0..1
Typedate
OralHealthClaim.item.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity
OralHealthClaim.item.unitPrice
Definition

If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

Control0..1
TypeMoney
OralHealthClaim.item.factor
Definition

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.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.points
Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.net
Definition

The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control0..1
TypeMoney
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.udi
Definition

List of Unique Device Identifiers associated with this line item.

Control0..1
BindingUDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.)
TypeCoding
Requirements

The UDI code and issuer if applicable for the supplied product.

OralHealthClaim.item.bodySite
Definition

Physical service site on the patient (limb, tooth, etc).

Control0..1
BindingOralSites: Example: See http://hl7.org/fhir/vs/tooth (The code for the teeth, quadrant, sextant and arch)
TypeCoding
OralHealthClaim.item.subsite
Definition

A region or surface of the site, eg. limb region or tooth surface(s).

Control0..*
BindingSurface: Example: See http://hl7.org/fhir/vs/surface (The code for the tooth surface and surface combinations)
TypeCoding
OralHealthClaim.item.modifier
Definition

Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

Control0..*
BindingModifiers: Example: See http://hl7.org/fhir/vs/modifiers (Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.)
TypeCoding
Requirements

May impact on adjudication.

OralHealthClaim.item.detail
Definition

Second tier of goods and services.

Control0..*
OralHealthClaim.item.detail.sequence
Definition

A service line number.

Control1..1
Typeinteger
OralHealthClaim.item.detail.type
Definition

The type of product or service.

Control1..1
BindingItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.)
TypeCoding
OralHealthClaim.item.detail.service
Definition

If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.

Control1..1
BindingServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes)
TypeCoding
OralHealthClaim.item.detail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity
OralHealthClaim.item.detail.unitPrice
Definition

If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

Control0..1
TypeMoney
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.factor
Definition

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.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.points
Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.net
Definition

The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control0..1
TypeMoney
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.udi
Definition

List of Unique Device Identifiers associated with this line item.

Control0..1
BindingUDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.)
TypeCoding
Requirements

The UDI code and issuer if applicable for the supplied product.

OralHealthClaim.item.detail.subDetail
Definition

Third tier of goods and services.

Control0..*
OralHealthClaim.item.detail.subDetail.sequence
Definition

A service line number.

Control1..1
Typeinteger
OralHealthClaim.item.detail.subDetail.type
Definition

The type of product or service.

Control1..1
BindingItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.)
TypeCoding
OralHealthClaim.item.detail.subDetail.service
Definition

The fee for an addittional service or product or charge.

Control1..1
BindingServiceProduct: Example: See http://hl7.org/fhir/vs/service-uscls (Allowable service and product codes)
TypeCoding
OralHealthClaim.item.detail.subDetail.quantity
Definition

The number of repetitions of a service or product.

Control0..1
TypeQuantity
OralHealthClaim.item.detail.subDetail.unitPrice
Definition

The fee for an addittional service or product or charge.

Control0..1
TypeMoney
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.subDetail.factor
Definition

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.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.subDetail.points
Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

Control0..1
Typedecimal
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.subDetail.net
Definition

The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control0..1
TypeMoney
Requirements

If a fee is present the associated product/service code must be present.

OralHealthClaim.item.detail.subDetail.udi
Definition

List of Unique Device Identifiers associated with this line item.

Control0..1
BindingUDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.)
TypeCoding
Requirements

The UDI code and issuer if applicable for the supplied product.

OralHealthClaim.item.prosthesis
Definition

The materials and placement date of prior fixed prosthesis.

Control0..1
OralHealthClaim.item.prosthesis.initial
Definition

Indicates whether this is the initial placement of a fixed prosthesis.

Control0..1
Typeboolean
Requirements

May impact on adjudication.

OralHealthClaim.item.prosthesis.priorDate
Definition

Date of the initial placement.

Control0..1
Typedate
Requirements

May impact on adjudication.

OralHealthClaim.item.prosthesis.priorMaterial
Definition

Material of the prior denture or bridge prosthesis. (Oral).

Control0..1
BindingOralProsthoMaterial: Example: See http://hl7.org/fhir/vs/oral-prosthodontic-material (Material of the prior denture or bridge prosthesis. (Oral))
TypeCoding
Requirements

May impact on adjudication.

OralHealthClaim.additionalMaterials
Definition

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

Control0..*
BindingAdditionalMaterials: Example: See http://hl7.org/fhir/vs/additionalmaterials (Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.)
TypeCoding