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
Detailed Descriptions for the elements in the PharmacyClaim resource.
PharmacyClaim | |
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. |
Control | 1..1 |
PharmacyClaim.identifier | |
Definition | The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. |
Control | 0..* |
Type | Identifier |
PharmacyClaim.ruleset | |
Definition | The version of the specification on which this instance relies. |
Control | 0..1 |
Binding | Ruleset: 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.) |
Type | Coding |
Alternate Names | BusinessVersion |
Comments | This is the version of the specification on which this instance relies. |
PharmacyClaim.originalRuleset | |
Definition | The version of the specification from which the original instance was created. |
Control | 0..1 |
Binding | Ruleset: 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.) |
Type | Coding |
Alternate Names | OriginalBusinessVersion |
Comments | This is the version of the specification on which the original instance relied (was create). |
PharmacyClaim.created | |
Definition | The date when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | dateTime |
PharmacyClaim.target | |
Definition | Insurer Identifier, typical BIN number (6 digit). |
Control | 0..1 |
Type | Reference(Organization) |
PharmacyClaim.provider | |
Definition | The provider which is responsible for the bill, claim pre-determination, pre-authorization. |
Control | 0..1 |
Type | Reference(Practitioner) |
PharmacyClaim.organization | |
Definition | The organization which is responsible for the bill, claim pre-determination, pre-authorization. |
Control | 0..1 |
Type | Reference(Organization) |
PharmacyClaim.use | |
Definition | Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination). |
Control | 0..1 |
Binding | Use: Required: http://hl7.org/fhir/use-link (Complete, proposed, exploratory, other) |
Type | code |
PharmacyClaim.priority | |
Definition | Immediate (STAT), best effort (NORMAL), deferred (DEFER). |
Control | 0..1 |
Binding | ProcessPriority: Example: See http://hl7.org/fhir/vs/process-priority (The timeliness with which processing is required: STAT, normal, Deferred) |
Type | Coding |
PharmacyClaim.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. |
Control | 0..1 |
Binding | FundsReserve: Example: See http://hl7.org/fhir/vs/fundsreserve (For whom funds are to be reserved: (Patient, Provider, None)) |
Type | Coding |
PharmacyClaim.enterer | |
Definition | Person who created the invoice/claim/pre-determination or pre-authorization. |
Control | 0..1 |
Type | Reference(Practitioner) |
PharmacyClaim.facility | |
Definition | Facility where the services were provided. |
Control | 0..1 |
Type | Reference(Location) |
PharmacyClaim.prescription | |
Definition | Prescription to support the dispensing of pharmacy services, medications or products. |
Control | 0..1 |
Type | Reference(MedicationPrescription) |
PharmacyClaim.originalPrescription | |
Definition | Original prescription to support the dispensing of pharmacy services, medications or products. |
Control | 0..1 |
Type | Reference(MedicationPrescription) |
PharmacyClaim.payee | |
Definition | The party to be reimbursed for the services. |
Control | 0..1 |
PharmacyClaim.payee.type | |
Definition | Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Binding | PayeeType: Example: See http://hl7.org/fhir/vs/payeetype (A code for the party to be reimbursed.) |
Type | Coding |
PharmacyClaim.payee.provider | |
Definition | The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned). |
Control | 0..1 |
Type | Reference(Practitioner) |
PharmacyClaim.payee.organization | |
Definition | The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned). |
Control | 0..1 |
Type | Reference(Organization) |
PharmacyClaim.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). |
Control | 0..1 |
Type | Reference(Patient) |
PharmacyClaim.referral | |
Definition | The referral resource which lists the date, practitioner, reason and other supporting information. |
Control | 0..1 |
Type | Reference(ReferralRequest) |
PharmacyClaim.diagnosis | |
Definition | Ordered list of patient diagnosis for which care is sought. |
Control | 0..* |
PharmacyClaim.diagnosis.sequence | |
Definition | Sequence of diagnosis. |
Control | 1..1 |
Type | integer |
Requirements | Required to maintain order of the diagnoses. |
PharmacyClaim.diagnosis.diagnosis | |
Definition | The diagnosis. |
Control | 1..1 |
Binding | ICD10: Example: See http://hl7.org/fhir/vs/icd-10 (ICD10 Diagnostic codes) |
Type | Coding |
Requirements | Required to adjudicate services rendered to condition presented. |
PharmacyClaim.condition | |
Definition | List of patient conditions for which care is sought. |
Control | 0..* |
Binding | Conditions: Example: See http://hl7.org/fhir/vs/fm-conditions (Patient conditions and symptoms) |
Type | Coding |
PharmacyClaim.patient | |
Definition | Patient Resource. |
Control | 1..1 |
Type | Reference(Patient) |
PharmacyClaim.coverage | |
Definition | Financial instrument by which payment information for health care. |
Control | 0..* |
Requirements | Health care programs and insurers are significant payors of health service costs. |
PharmacyClaim.coverage.sequence | |
Definition | A service line item. |
Control | 1..1 |
Type | integer |
Requirements | To maintain order of the coverages. |
PharmacyClaim.coverage.focal | |
Definition | The instance number of the Coverage which is the focus for adjudication. The Coverage to against which the claim is to be adjudicated. |
Control | 1..1 |
Type | boolean |
Requirements | To identify which coverage is being adjudicated. |
PharmacyClaim.coverage.coverage | |
Definition | Reference to the program or plan identification, underwriter or payor. |
Control | 1..1 |
Type | Reference(Coverage) |
Requirements | Need to identify the issuer to target for processing and for coordination of benefit processing. |
PharmacyClaim.coverage.businessArrangement | |
Definition | The contract number of a business agreement which describes the terms and conditions. |
Control | 0..1 |
Type | string |
PharmacyClaim.coverage.relationship | |
Definition | The relationship of the patient to the subscriber. |
Control | 1..1 |
Binding | Relationship: Example: See http://hl7.org/fhir/vs/relationship (The code for the relationship of the patient to the subscriber) |
Type | Coding |
Requirements | To determine relationship between the patient and the subscriber. |
PharmacyClaim.coverage.preauthref | |
Definition | A list of references from the Insurer to which these services pertain. |
Control | 0..* |
Type | string |
Requirements | To provide any pre=determination or prior authorization reference. |
PharmacyClaim.coverage.claimResponse | |
Definition | The Coverages adjudication details. |
Control | 0..1 |
Type | Reference(ClaimResponse) |
Requirements | Used by downstream payers to determine what balance remains and the net payable. |
PharmacyClaim.coverage.originalRuleset | |
Definition | The style (standard) and version of the original material which was converted into this resource. |
Control | 0..1 |
Binding | Ruleset: 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.) |
Type | Coding |
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. |
PharmacyClaim.exception | |
Definition | Factors which may influence the applicability of coverage. |
Control | 0..* |
Binding | Exception: Example: See http://hl7.org/fhir/vs/exception (The eligibility exception codes.) |
Type | Coding |
Requirements | To determine extenuating circumstances for coverage. |
PharmacyClaim.school | |
Definition | Name of school for over-aged dependants. |
Control | 0..1 |
Type | string |
Requirements | Often required for over-age dependents. |
PharmacyClaim.accident | |
Definition | Date of an accident which these services are addressing. |
Control | 0..1 |
Type | date |
Requirements | Coverage may be dependant on accidents. |
PharmacyClaim.accidentType | |
Definition | Type of accident: work, auto, etc. |
Control | 0..1 |
Binding | AccidentType: Example: See http://hl7.org/fhir/vs/ActIncidentCode (Type of accident: work place, auto, etc.) |
Type | Coding |
Requirements | Coverage may be dependant on the type of accident. |
PharmacyClaim.interventionException | |
Definition | A list of intervention and exception codes which may influence the adjudication of the claim. |
Control | 0..* |
Binding | Intervention: Example: See http://hl7.org/fhir/vs/intervention (Intervention and exception codes (Pharm)) |
Type | Coding |
Requirements | Coverage may be modified based on exception information provided. |
PharmacyClaim.item | |
Definition | First tier of goods and services. |
Control | 0..* |
PharmacyClaim.item.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | integer |
PharmacyClaim.item.type | |
Definition | The type of product or service. |
Control | 1..1 |
Binding | ItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.) |
Type | Coding |
PharmacyClaim.item.provider | |
Definition | The practitioner who is responsible for the services rendered to the patient. |
Control | 0..1 |
Type | Reference(Practitioner) |
PharmacyClaim.item.diagnosisLinkId | |
Definition | Diagnosis applicable for this service or product line. |
Control | 0..* |
Type | integer |
PharmacyClaim.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. |
Control | 1..1 |
Binding | PharmacyServiceProduct: Example: See http://hl7.org/fhir/vs/service-pharmacy (Allowable service and product codes) |
Type | Coding |
PharmacyClaim.item.serviceDate | |
Definition | The date when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | date |
PharmacyClaim.item.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity |
PharmacyClaim.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. |
Control | 0..1 |
Type | Money |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.net | |
Definition | The quantity times the unit price for an additional 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. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..1 |
Binding | UDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.) |
Type | Coding |
Requirements | The UDI code and issuer if applicable for the supplied product. |
PharmacyClaim.item.bodySite | |
Definition | Physical service site on the patient (limb, tooth, etc). |
Control | 0..1 |
Binding | ICD10: Example: See http://hl7.org/fhir/vs/icd-10 (ICD10 Diagnostic codes) |
Type | Coding |
PharmacyClaim.item.subsite | |
Definition | A region or surface of the site, eg. limb region or tooth surface(s). |
Control | 0..* |
Binding | ICD10: Example: See http://hl7.org/fhir/vs/icd-10 (ICD10 Diagnostic codes) |
Type | Coding |
PharmacyClaim.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. |
Control | 0..* |
Binding | Modifiers: 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.) |
Type | Coding |
Requirements | May impact on adjudication. |
PharmacyClaim.item.detail | |
Definition | Second tier of goods and services. |
Control | 0..* |
PharmacyClaim.item.detail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | integer |
PharmacyClaim.item.detail.type | |
Definition | The type of product or service. |
Control | 1..1 |
Binding | ItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.) |
Type | Coding |
PharmacyClaim.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. |
Control | 1..1 |
Binding | PharmacyServiceProduct: Example: See http://hl7.org/fhir/vs/service-pharmacy (Allowable service and product codes) |
Type | Coding |
PharmacyClaim.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity |
PharmacyClaim.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. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.detail.net | |
Definition | The quantity times the unit price for an additional 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. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.detail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..1 |
Binding | UDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.) |
Type | Coding |
Requirements | The UDI code and issuer if applicable for the supplied product. |
PharmacyClaim.item.detail.subDetail | |
Definition | Third tier of goods and services. |
Control | 0..* |
PharmacyClaim.item.detail.subDetail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | integer |
PharmacyClaim.item.detail.subDetail.type | |
Definition | The type of product or service. |
Control | 1..1 |
Binding | ItemType: Example: See http://hl7.org/fhir/vs/ActInvoiceGroupCode (Service, Product, Rx Dispense, Rx Compound etc.) |
Type | Coding |
PharmacyClaim.item.detail.subDetail.service | |
Definition | The fee for an additional service or product or charge. |
Control | 1..1 |
Binding | PharmacyServiceProduct: Example: See http://hl7.org/fhir/vs/service-pharmacy (Allowable service and product codes) |
Type | Coding |
PharmacyClaim.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity |
PharmacyClaim.item.detail.subDetail.unitPrice | |
Definition | The fee for an additional service or product or charge. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.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. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.detail.subDetail.net | |
Definition | The quantity times the unit price for an additional 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. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
PharmacyClaim.item.detail.subDetail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..1 |
Binding | UDI: Example: See http://hl7.org/fhir/vs/udi (The FDA, or other, UDI repository.) |
Type | Coding |
Requirements | The UDI code and issuer if applicable for the supplied product. |
PharmacyClaim.additionalMaterials | |
Definition | Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission. |
Control | 0..* |
Binding | AdditionalMaterials: 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.) |
Type | Coding |