This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 R3 R2
Financial Management Work Group | Maturity Level: 2 | Trial Use | Security Category: Patient | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
The Claim is used by providers and payors, insurers, to exchange the financial information, and supporting clinical information, regarding the provision of health care services with payors and for reporting to regulatory bodies and firms which provide data analytics. The primary uses of this resource is to support eClaims, the exchange of information relating to the proposed or actual provision of healthcare-related goods and services for patients to their benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
The Claim resource is a "request" resource from a FHIR workflow perspective - see Workflow Request.
The Claim resource may be interpreted differently depending on its intended use (and the Claim.use element contains the code to indicate):
The Claim.type code system provides oral, pharmacy, vision, professional and institutional claim types. Claim types supported are influenced by the requirements of the implementing jurisdiction. The valueset is extensible to accommodate other types of claims as required by the jurisdiction.
The Claim also supports:
Mapping to other Claim specifications: Mappings are currently maintained by the Financial Management Work Group to UB04 and CMS1500 and are available at https://confluence.hl7.org/display/FM/FHIR+Resource+Development . Mappings to other specifications may be made available where IP restrictions permit.
Additional information regarding electronic claims content and usage may be found at:
The Claim resource is used to request the adjudication and/or authorization of a set of healthcare-related goods and services for a patient against the patient's insurance coverages, or to request what the adjudication would be for a supplied set of goods or services should they be actually supplied to the patient.
When requesting whether the patient's coverage is inforce, whether it is valid at this or a specified date, or requesting the benefit details or preauthorization requirements associated with a coverage, then CoverageEligibilityRequest should be used instead.
When using the resources for reporting and transferring claims data, which may have originated in some standard other than FHIR, the Claim resource is useful if only the request side of the information exchange is of interest. If, however, both the request and the adjudication information is to be reported then the ExplanationOfBenefit should be used instead.
For reporting out to patients or transferring data to patient centered applications, such as Personal Health Record (PHR) application, the ExplanationOfBenefit should be used instead of the Claim and ClaimResponse resources as those resources may contain provider and payer specific information which is not appropriate for sharing with the patient.
The eClaim domain includes a number of related resources
Claim | A suite of goods and services and insurances coverages under which adjudication or authorization is requested. |
CoverageEligibilityRequest | A request to a payor to: ascertain whether a coverage is in-force at the current or at a specified time; list the table of benefits; determine whether coverage is provided for specified categories or specific services; and whether preauthorization is required, and if so what supporting information would be required. |
ClaimResponse | A payor's adjudication and/or authorization response to the suite of services provided in a Claim. Typically the ClaimResponse references the Claim but does not duplicate the clinical or financial information provided in the claim. |
ExplanationOfBenefit | This resource combines the information from the Claim and the ClaimResponse, stripping out any provider or payor proprietary information, into a unified information model suitable for use for: patient reporting; transferring information to a Patient Health Record system; and, supporting complete claim and adjudication information exchange with regulatory and analytics organizations and other parts of the provider's organization. |
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | TU | DomainResource | Claim, Pre-determination or Pre-authorization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | 0..* | Identifier | Business Identifier for claim | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
type | Σ | 1..1 | CodeableConcept | Category or discipline Claim Type Codes (Extensible) |
subType | 0..1 | CodeableConcept | More granular claim type Example Claim SubType Codes (Example) | |
use | Σ | 1..1 | code | claim | preauthorization | predetermination Use (Required) |
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim |
created | Σ | 1..1 | dateTime | Resource creation date |
enterer | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Author of the claim | |
insurer | Σ | 0..1 | Reference(Organization) | Target |
provider | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim |
priority | Σ | 0..1 | CodeableConcept | Desired processing urgency Process Priority Codes (Example) |
fundsReserve | 0..1 | CodeableConcept | For whom to reserve funds FundsReserve (Example) | |
related | 0..* | BackboneElement | Prior or corollary claims | |
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
relationship | 0..1 | CodeableConcept | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | File or case reference | |
prescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
payee | 0..1 | BackboneElement | Recipient of benefits payable | |
type | 1..1 | CodeableConcept | Category of recipient PayeeType (Example) | |
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |
diagnosisRelatedGroup | 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | |
careTeam | 0..* | BackboneElement | Members of the care team | |
sequence | 1..1 | positiveInt | Order of care team | |
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | |
responsible | 0..1 | boolean | Indicator of the lead practitioner | |
role | 0..1 | CodeableConcept | Function within the team Claim Care Team Role Codes (Example) | |
specialty | 0..1 | CodeableConcept | Practitioner or provider specialization Example Provider Qualification Codes (Example) | |
supportingInfo | 0..* | BackboneElement | Supporting information | |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | Classification of the supplied information Claim Information Category Codes (Example) | |
code | 0..1 | CodeableConcept | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Data to be provided | ||
valueBoolean | boolean | |||
valueString | string | |||
valueQuantity | Quantity | |||
valueAttachment | Attachment | |||
valueReference | Reference(Any) | |||
valueIdentifier | Identifier | |||
reason | 0..1 | CodeableConcept | Explanation for the information Missing Tooth Reason Codes (Example) | |
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |
sequence | 1..1 | positiveInt | Diagnosis instance identifier | |
diagnosis[x] | 1..1 | Nature of illness or problem ICD-10 Codes (Example) | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | |
onAdmission | 0..1 | CodeableConcept | Present on admission Example Diagnosis on Admission Codes (Example) | |
procedure | 0..* | BackboneElement | Clinical procedures performed | |
sequence | 1..1 | positiveInt | Procedure instance identifier | |
type | 0..* | CodeableConcept | Category of Procedure Example Procedure Type Codes (Example) | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Specific clinical procedure ICD-10 Procedure Codes (Example) | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
udi | 0..* | Reference(Device) | Unique device identifier | |
insurance | Σ | 0..* | BackboneElement | Patient insurance information |
sequence | Σ | 1..1 | positiveInt | Insurance instance identifier |
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication |
identifier | 0..1 | Identifier | Pre-assigned Claim number | |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
businessArrangement | 0..1 | string | Additional provider contract number | |
preAuthRef | 0..* | string | Prior authorization reference number | |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
accident | 0..1 | BackboneElement | Details of the event | |
date | 1..1 | date | When the incident occurred | |
type | 0..1 | CodeableConcept | The nature of the accident ActIncidentCode (Extensible) | |
location[x] | 0..1 | Where the event occurred | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
patientPaid | 0..1 | Money | Paid by the patient | |
item | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
careTeamSequence | 0..* | positiveInt | Applicable careTeam members | |
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |
procedureSequence | 0..* | positiveInt | Applicable procedures | |
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Product or service billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of service or product delivery | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service or where product was supplied Example Service Place Codes (Example) | ||
locationCodeableConcept | CodeableConcept | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
bodySite | 0..* | BackboneElement | Anatomical location | |
site | 1..* | CodeableReference(BodyStructure) | Location Oral Site Codes (Example) | |
subSite | 0..* | CodeableConcept | Sub-location Surface Codes (Example) | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
detail | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
subDetail | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
total | 0..1 | Money | Total claim cost | |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier for claim --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <type><!-- 1..1 CodeableConcept Category or discipline --></type> <subType><!-- 0..1 CodeableConcept More granular claim type --></subType> <use value="[code]"/><!-- 1..1 claim | preauthorization | predetermination --> <patient><!-- 1..1 Reference(Patient) The recipient of the products and services --></patient> <billablePeriod><!-- 0..1 Period Relevant time frame for the claim --></billablePeriod> <created value="[dateTime]"/><!-- 1..1 Resource creation date --> <enterer><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) Author of the claim --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer> <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Party responsible for the claim --></provider> <priority><!-- 0..1 CodeableConcept Desired processing urgency --></priority> <fundsReserve><!-- 0..1 CodeableConcept For whom to reserve funds --></fundsReserve> <related> <!-- 0..* Prior or corollary claims --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier File or case reference --></reference> </related> <prescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest| VisionPrescription) Prescription authorizing services and products --></prescription> <originalPrescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest| VisionPrescription) Original prescription if superseded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Recipient of benefits payable --> <type><!-- 1..1 CodeableConcept Category of recipient --></type> <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Recipient reference --></party> </payee> <referral><!-- 0..1 Reference(ServiceRequest) Treatment referral --></referral> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <facility><!-- 0..1 Reference(Location|Organization) Servicing facility --></facility> <diagnosisRelatedGroup><!-- 0..1 CodeableConcept Package billing code --></diagnosisRelatedGroup> <careTeam> <!-- 0..* Members of the care team --> <sequence value="[positiveInt]"/><!-- 1..1 Order of care team --> <provider><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Practitioner or organization --></provider> <responsible value="[boolean]"/><!-- 0..1 Indicator of the lead practitioner --> <role><!-- 0..1 CodeableConcept Function within the team --></role> <specialty><!-- 0..1 CodeableConcept Practitioner or provider specialization --></specialty> </careTeam> <supportingInfo> <!-- 0..* Supporting information --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept Classification of the supplied information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any)| Identifier Data to be provided --></value[x]> <reason><!-- 0..1 CodeableConcept Explanation for the information --></reason> </supportingInfo> <diagnosis> <!-- 0..* Pertinent diagnosis information --> <sequence value="[positiveInt]"/><!-- 1..1 Diagnosis instance identifier --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Nature of illness or problem --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <onAdmission><!-- 0..1 CodeableConcept Present on admission --></onAdmission> </diagnosis> <procedure> <!-- 0..* Clinical procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure instance identifier --> <type><!-- 0..* CodeableConcept Category of Procedure --></type> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Specific clinical procedure --></procedure[x]> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </procedure> <insurance> <!-- 0..* Patient insurance information --> <sequence value="[positiveInt]"/><!-- 1..1 Insurance instance identifier --> <focal value="[boolean]"/><!-- 1..1 Coverage to be used for adjudication --> <identifier><!-- 0..1 Identifier Pre-assigned Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Additional provider contract number --> <preAuthRef value="[string]"/><!-- 0..* Prior authorization reference number --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details of the event --> <date value="[date]"/><!-- 1..1 When the incident occurred --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Where the event occurred --></location[x]> </accident> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <item> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careTeam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Product or service billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of service or product delivery --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service or where product was supplied --></location[x]> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <bodySite> <!-- 0..* Anatomical location --> <site><!-- 1..* CodeableReference(BodyStructure) Location --></site> <subSite><!-- 0..* CodeableConcept Sub-location --></subSite> </bodySite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <detail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <subDetail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </subDetail> </detail> </item> <total><!-- 0..1 Money Total claim cost --></total> </Claim>
JSON Template
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier for claim "status" : "<code>", // R! active | cancelled | draft | entered-in-error "type" : { CodeableConcept }, // R! Category or discipline "subType" : { CodeableConcept }, // More granular claim type "use" : "<code>", // R! claim | preauthorization | predetermination "patient" : { Reference(Patient) }, // R! The recipient of the products and services "billablePeriod" : { Period }, // Relevant time frame for the claim "created" : "<dateTime>", // R! Resource creation date "enterer" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Author of the claim "insurer" : { Reference(Organization) }, // Target "provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Party responsible for the claim "priority" : { CodeableConcept }, // Desired processing urgency "fundsReserve" : { CodeableConcept }, // For whom to reserve funds "related" : [{ // Prior or corollary claims "claim" : { Reference(Claim) }, // Reference to the related claim "relationship" : { CodeableConcept }, // How the reference claim is related "reference" : { Identifier } // File or case reference }], "prescription" : { Reference(DeviceRequest|MedicationRequest| VisionPrescription) }, // Prescription authorizing services and products "originalPrescription" : { Reference(DeviceRequest|MedicationRequest| VisionPrescription) }, // Original prescription if superseded by fulfiller "payee" : { // Recipient of benefits payable "type" : { CodeableConcept }, // R! Category of recipient "party" : { Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) } // Recipient reference }, "referral" : { Reference(ServiceRequest) }, // Treatment referral "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "facility" : { Reference(Location|Organization) }, // Servicing facility "diagnosisRelatedGroup" : { CodeableConcept }, // Package billing code "careTeam" : [{ // Members of the care team "sequence" : "<positiveInt>", // R! Order of care team "provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // R! Practitioner or organization "responsible" : <boolean>, // Indicator of the lead practitioner "role" : { CodeableConcept }, // Function within the team "specialty" : { CodeableConcept } // Practitioner or provider specialization }], "supportingInfo" : [{ // Supporting information "sequence" : "<positiveInt>", // R! Information instance identifier "category" : { CodeableConcept }, // R! Classification of the supplied information "code" : { CodeableConcept }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Data to be provided. One of these 6: "valueBoolean" : <boolean>, "valueString" : "<string>", "valueQuantity" : { Quantity }, "valueAttachment" : { Attachment }, "valueReference" : { Reference(Any) }, "valueIdentifier" : { Identifier }, "reason" : { CodeableConcept } // Explanation for the information }], "diagnosis" : [{ // Pertinent diagnosis information "sequence" : "<positiveInt>", // R! Diagnosis instance identifier // diagnosis[x]: Nature of illness or problem. One of these 2: "diagnosisCodeableConcept" : { CodeableConcept }, "diagnosisReference" : { Reference(Condition) }, "type" : [{ CodeableConcept }], // Timing or nature of the diagnosis "onAdmission" : { CodeableConcept } // Present on admission }], "procedure" : [{ // Clinical procedures performed "sequence" : "<positiveInt>", // R! Procedure instance identifier "type" : [{ CodeableConcept }], // Category of Procedure "date" : "<dateTime>", // When the procedure was performed // procedure[x]: Specific clinical procedure. One of these 2: "procedureCodeableConcept" : { CodeableConcept }, "procedureReference" : { Reference(Procedure) }, "udi" : [{ Reference(Device) }] // Unique device identifier }], "insurance" : [{ // Patient insurance information "sequence" : "<positiveInt>", // R! Insurance instance identifier "focal" : <boolean>, // R! Coverage to be used for adjudication "identifier" : { Identifier }, // Pre-assigned Claim number "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Additional provider contract number "preAuthRef" : ["<string>"], // Prior authorization reference number "claimResponse" : { Reference(ClaimResponse) } // Adjudication results }], "accident" : { // Details of the event "date" : "<date>", // R! When the incident occurred "type" : { CodeableConcept }, // The nature of the accident // location[x]: Where the event occurred. One of these 2: "locationAddress" : { Address }, "locationReference" : { Reference(Location) } }, "patientPaid" : { Money }, // Paid by the patient "item" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "careTeamSequence" : ["<positiveInt>"], // Applicable careTeam members "diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses "procedureSequence" : ["<positiveInt>"], // Applicable procedures "informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Product or service billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under // serviced[x]: Date or dates of service or product delivery. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, // location[x]: Place of service or where product was supplied. One of these 3: "locationCodeableConcept" : { CodeableConcept }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique device identifier "bodySite" : [{ // Anatomical location "site" : [{ CodeableReference(BodyStructure) }], // R! Location "subSite" : [{ CodeableConcept }] // Sub-location }], "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "detail" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique device identifier "subDetail" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }] // Unique device identifier }] }] }], "total" : { Money } // Total claim cost }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Claim.identifier [ Identifier ], ... ; # 0..* Business Identifier for claim fhir:Claim.status [ code ]; # 1..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ CodeableConcept ]; # 1..1 Category or discipline fhir:Claim.subType [ CodeableConcept ]; # 0..1 More granular claim type fhir:Claim.use [ code ]; # 1..1 claim | preauthorization | predetermination fhir:Claim.patient [ Reference(Patient) ]; # 1..1 The recipient of the products and services fhir:Claim.billablePeriod [ Period ]; # 0..1 Relevant time frame for the claim fhir:Claim.created [ dateTime ]; # 1..1 Resource creation date fhir:Claim.enterer [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Author of the claim fhir:Claim.insurer [ Reference(Organization) ]; # 0..1 Target fhir:Claim.provider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Party responsible for the claim fhir:Claim.priority [ CodeableConcept ]; # 0..1 Desired processing urgency fhir:Claim.fundsReserve [ CodeableConcept ]; # 0..1 For whom to reserve funds fhir:Claim.related [ # 0..* Prior or corollary claims fhir:Claim.related.claim [ Reference(Claim) ]; # 0..1 Reference to the related claim fhir:Claim.related.relationship [ CodeableConcept ]; # 0..1 How the reference claim is related fhir:Claim.related.reference [ Identifier ]; # 0..1 File or case reference ], ...; fhir:Claim.prescription [ Reference(DeviceRequest|MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services and products fhir:Claim.originalPrescription [ Reference(DeviceRequest|MedicationRequest|VisionPrescription) ]; # 0..1 Original prescription if superseded by fulfiller fhir:Claim.payee [ # 0..1 Recipient of benefits payable fhir:Claim.payee.type [ CodeableConcept ]; # 1..1 Category of recipient fhir:Claim.payee.party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Recipient reference ]; fhir:Claim.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment referral fhir:Claim.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.facility [ Reference(Location|Organization) ]; # 0..1 Servicing facility fhir:Claim.diagnosisRelatedGroup [ CodeableConcept ]; # 0..1 Package billing code fhir:Claim.careTeam [ # 0..* Members of the care team fhir:Claim.careTeam.sequence [ positiveInt ]; # 1..1 Order of care team fhir:Claim.careTeam.provider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 1..1 Practitioner or organization fhir:Claim.careTeam.responsible [ boolean ]; # 0..1 Indicator of the lead practitioner fhir:Claim.careTeam.role [ CodeableConcept ]; # 0..1 Function within the team fhir:Claim.careTeam.specialty [ CodeableConcept ]; # 0..1 Practitioner or provider specialization ], ...; fhir:Claim.supportingInfo [ # 0..* Supporting information fhir:Claim.supportingInfo.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:Claim.supportingInfo.category [ CodeableConcept ]; # 1..1 Classification of the supplied information fhir:Claim.supportingInfo.code [ CodeableConcept ]; # 0..1 Type of information # Claim.supportingInfo.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.supportingInfo.timingDate [ date ] fhir:Claim.supportingInfo.timingPeriod [ Period ] # Claim.supportingInfo.value[x] : 0..1 Data to be provided. One of these 6 fhir:Claim.supportingInfo.valueBoolean [ boolean ] fhir:Claim.supportingInfo.valueString [ string ] fhir:Claim.supportingInfo.valueQuantity [ Quantity ] fhir:Claim.supportingInfo.valueAttachment [ Attachment ] fhir:Claim.supportingInfo.valueReference [ Reference(Any) ] fhir:Claim.supportingInfo.valueIdentifier [ Identifier ] fhir:Claim.supportingInfo.reason [ CodeableConcept ]; # 0..1 Explanation for the information ], ...; fhir:Claim.diagnosis [ # 0..* Pertinent diagnosis information fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Diagnosis instance identifier # Claim.diagnosis.diagnosis[x] : 1..1 Nature of illness or problem. One of these 2 fhir:Claim.diagnosis.diagnosisCodeableConcept [ CodeableConcept ] fhir:Claim.diagnosis.diagnosisReference [ Reference(Condition) ] fhir:Claim.diagnosis.type [ CodeableConcept ], ... ; # 0..* Timing or nature of the diagnosis fhir:Claim.diagnosis.onAdmission [ CodeableConcept ]; # 0..1 Present on admission ], ...; fhir:Claim.procedure [ # 0..* Clinical procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure instance identifier fhir:Claim.procedure.type [ CodeableConcept ], ... ; # 0..* Category of Procedure fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Specific clinical procedure. One of these 2 fhir:Claim.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] fhir:Claim.procedure.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier ], ...; fhir:Claim.insurance [ # 0..* Patient insurance information fhir:Claim.insurance.sequence [ positiveInt ]; # 1..1 Insurance instance identifier fhir:Claim.insurance.focal [ boolean ]; # 1..1 Coverage to be used for adjudication fhir:Claim.insurance.identifier [ Identifier ]; # 0..1 Pre-assigned Claim number fhir:Claim.insurance.coverage [ Reference(Coverage) ]; # 1..1 Insurance information fhir:Claim.insurance.businessArrangement [ string ]; # 0..1 Additional provider contract number fhir:Claim.insurance.preAuthRef [ string ], ... ; # 0..* Prior authorization reference number fhir:Claim.insurance.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results ], ...; fhir:Claim.accident [ # 0..1 Details of the event fhir:Claim.accident.date [ date ]; # 1..1 When the incident occurred fhir:Claim.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Where the event occurred. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ]; fhir:Claim.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item [ # 0..* Product or service provided fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.careTeamSequence [ positiveInt ], ... ; # 0..* Applicable careTeam members fhir:Claim.item.diagnosisSequence [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:Claim.item.procedureSequence [ positiveInt ], ... ; # 0..* Applicable procedures fhir:Claim.item.informationSequence [ positiveInt ], ... ; # 0..* Applicable exception and supporting information fhir:Claim.item.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.modifier [ CodeableConcept ], ... ; # 0..* Product or service billing modifiers fhir:Claim.item.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under # Claim.item.serviced[x] : 0..1 Date or dates of service or product delivery. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service or where product was supplied. One of these 3 fhir:Claim.item.locationCodeableConcept [ CodeableConcept ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] fhir:Claim.item.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier fhir:Claim.item.bodySite [ # 0..* Anatomical location fhir:Claim.item.bodySite.site [ CodeableReference(BodyStructure) ], ... ; # 1..* Location fhir:Claim.item.bodySite.subSite [ CodeableConcept ], ... ; # 0..* Sub-location ], ...; fhir:Claim.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.item.detail [ # 0..* Product or service provided fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.detail.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.detail.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under fhir:Claim.item.detail.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.detail.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier fhir:Claim.item.detail.subDetail [ # 0..* Product or service provided fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.detail.subDetail.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.detail.subDetail.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under fhir:Claim.item.detail.subDetail.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier ], ...; ], ...; ], ...; fhir:Claim.total [ Money ]; # 0..1 Total claim cost ]
Changes since R4
Claim | |
Claim.enterer |
|
Claim.provider |
|
Claim.priority |
|
Claim.encounter |
|
Claim.facility |
|
Claim.diagnosisRelatedGroup |
|
Claim.careTeam.specialty |
|
Claim.supportingInfo.value[x] |
|
Claim.insurance |
|
Claim.patientPaid |
|
Claim.item.productOrService |
|
Claim.item.productOrServiceEnd |
|
Claim.item.patientPaid |
|
Claim.item.tax |
|
Claim.item.bodySite |
|
Claim.item.bodySite.site |
|
Claim.item.bodySite.subSite |
|
Claim.item.detail.productOrService |
|
Claim.item.detail.productOrServiceEnd |
|
Claim.item.detail.patientPaid |
|
Claim.item.detail.tax |
|
Claim.item.detail.subDetail.productOrService |
|
Claim.item.detail.subDetail.productOrServiceEnd |
|
Claim.item.detail.subDetail.patientPaid |
|
Claim.item.detail.subDetail.tax |
|
Claim.careTeam.qualification |
|
Claim.diagnosis.packageCode |
|
Claim.item.subSite |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 16 tests of which 3 fail to execute. 13 fail round-trip testing and 3 r3 resources are invalid (0 errors).)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | TU | DomainResource | Claim, Pre-determination or Pre-authorization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | 0..* | Identifier | Business Identifier for claim | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) |
type | Σ | 1..1 | CodeableConcept | Category or discipline Claim Type Codes (Extensible) |
subType | 0..1 | CodeableConcept | More granular claim type Example Claim SubType Codes (Example) | |
use | Σ | 1..1 | code | claim | preauthorization | predetermination Use (Required) |
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim |
created | Σ | 1..1 | dateTime | Resource creation date |
enterer | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Author of the claim | |
insurer | Σ | 0..1 | Reference(Organization) | Target |
provider | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim |
priority | Σ | 0..1 | CodeableConcept | Desired processing urgency Process Priority Codes (Example) |
fundsReserve | 0..1 | CodeableConcept | For whom to reserve funds FundsReserve (Example) | |
related | 0..* | BackboneElement | Prior or corollary claims | |
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
relationship | 0..1 | CodeableConcept | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | File or case reference | |
prescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
payee | 0..1 | BackboneElement | Recipient of benefits payable | |
type | 1..1 | CodeableConcept | Category of recipient PayeeType (Example) | |
party | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |
diagnosisRelatedGroup | 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | |
careTeam | 0..* | BackboneElement | Members of the care team | |
sequence | 1..1 | positiveInt | Order of care team | |
provider | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | |
responsible | 0..1 | boolean | Indicator of the lead practitioner | |
role | 0..1 | CodeableConcept | Function within the team Claim Care Team Role Codes (Example) | |
specialty | 0..1 | CodeableConcept | Practitioner or provider specialization Example Provider Qualification Codes (Example) | |
supportingInfo | 0..* | BackboneElement | Supporting information | |
sequence | 1..1 | positiveInt | Information instance identifier | |
category | 1..1 | CodeableConcept | Classification of the supplied information Claim Information Category Codes (Example) | |
code | 0..1 | CodeableConcept | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Data to be provided | ||
valueBoolean | boolean | |||
valueString | string | |||
valueQuantity | Quantity | |||
valueAttachment | Attachment | |||
valueReference | Reference(Any) | |||
valueIdentifier | Identifier | |||
reason | 0..1 | CodeableConcept | Explanation for the information Missing Tooth Reason Codes (Example) | |
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |
sequence | 1..1 | positiveInt | Diagnosis instance identifier | |
diagnosis[x] | 1..1 | Nature of illness or problem ICD-10 Codes (Example) | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | |
onAdmission | 0..1 | CodeableConcept | Present on admission Example Diagnosis on Admission Codes (Example) | |
procedure | 0..* | BackboneElement | Clinical procedures performed | |
sequence | 1..1 | positiveInt | Procedure instance identifier | |
type | 0..* | CodeableConcept | Category of Procedure Example Procedure Type Codes (Example) | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Specific clinical procedure ICD-10 Procedure Codes (Example) | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
udi | 0..* | Reference(Device) | Unique device identifier | |
insurance | Σ | 0..* | BackboneElement | Patient insurance information |
sequence | Σ | 1..1 | positiveInt | Insurance instance identifier |
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication |
identifier | 0..1 | Identifier | Pre-assigned Claim number | |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
businessArrangement | 0..1 | string | Additional provider contract number | |
preAuthRef | 0..* | string | Prior authorization reference number | |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
accident | 0..1 | BackboneElement | Details of the event | |
date | 1..1 | date | When the incident occurred | |
type | 0..1 | CodeableConcept | The nature of the accident ActIncidentCode (Extensible) | |
location[x] | 0..1 | Where the event occurred | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
patientPaid | 0..1 | Money | Paid by the patient | |
item | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
careTeamSequence | 0..* | positiveInt | Applicable careTeam members | |
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |
procedureSequence | 0..* | positiveInt | Applicable procedures | |
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Product or service billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of service or product delivery | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service or where product was supplied Example Service Place Codes (Example) | ||
locationCodeableConcept | CodeableConcept | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
bodySite | 0..* | BackboneElement | Anatomical location | |
site | 1..* | CodeableReference(BodyStructure) | Location Oral Site Codes (Example) | |
subSite | 0..* | CodeableConcept | Sub-location Surface Codes (Example) | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
detail | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
subDetail | 0..* | BackboneElement | Product or service provided | |
sequence | 1..1 | positiveInt | Item instance identifier | |
revenue | 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | |
productOrServiceEnd | 0..1 | CodeableConcept | End of a range of codes USCLS Codes (Example) | |
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason Codes (Example) | |
patientPaid | 0..1 | Money | Paid by the patient | |
quantity | 0..1 | SimpleQuantity | Count of products or services | |
unitPrice | 0..1 | Money | Fee, charge or cost per item | |
factor | 0..1 | decimal | Price scaling factor | |
tax | 0..1 | Money | Total tax | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique device identifier | |
total | 0..1 | Money | Total claim cost | |
Documentation for this format |
See the Extensions for this resource
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier for claim --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <type><!-- 1..1 CodeableConcept Category or discipline --></type> <subType><!-- 0..1 CodeableConcept More granular claim type --></subType> <use value="[code]"/><!-- 1..1 claim | preauthorization | predetermination --> <patient><!-- 1..1 Reference(Patient) The recipient of the products and services --></patient> <billablePeriod><!-- 0..1 Period Relevant time frame for the claim --></billablePeriod> <created value="[dateTime]"/><!-- 1..1 Resource creation date --> <enterer><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) Author of the claim --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer> <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Party responsible for the claim --></provider> <priority><!-- 0..1 CodeableConcept Desired processing urgency --></priority> <fundsReserve><!-- 0..1 CodeableConcept For whom to reserve funds --></fundsReserve> <related> <!-- 0..* Prior or corollary claims --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier File or case reference --></reference> </related> <prescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest| VisionPrescription) Prescription authorizing services and products --></prescription> <originalPrescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest| VisionPrescription) Original prescription if superseded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Recipient of benefits payable --> <type><!-- 1..1 CodeableConcept Category of recipient --></type> <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Recipient reference --></party> </payee> <referral><!-- 0..1 Reference(ServiceRequest) Treatment referral --></referral> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <facility><!-- 0..1 Reference(Location|Organization) Servicing facility --></facility> <diagnosisRelatedGroup><!-- 0..1 CodeableConcept Package billing code --></diagnosisRelatedGroup> <careTeam> <!-- 0..* Members of the care team --> <sequence value="[positiveInt]"/><!-- 1..1 Order of care team --> <provider><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Practitioner or organization --></provider> <responsible value="[boolean]"/><!-- 0..1 Indicator of the lead practitioner --> <role><!-- 0..1 CodeableConcept Function within the team --></role> <specialty><!-- 0..1 CodeableConcept Practitioner or provider specialization --></specialty> </careTeam> <supportingInfo> <!-- 0..* Supporting information --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept Classification of the supplied information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any)| Identifier Data to be provided --></value[x]> <reason><!-- 0..1 CodeableConcept Explanation for the information --></reason> </supportingInfo> <diagnosis> <!-- 0..* Pertinent diagnosis information --> <sequence value="[positiveInt]"/><!-- 1..1 Diagnosis instance identifier --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Nature of illness or problem --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <onAdmission><!-- 0..1 CodeableConcept Present on admission --></onAdmission> </diagnosis> <procedure> <!-- 0..* Clinical procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure instance identifier --> <type><!-- 0..* CodeableConcept Category of Procedure --></type> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Specific clinical procedure --></procedure[x]> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </procedure> <insurance> <!-- 0..* Patient insurance information --> <sequence value="[positiveInt]"/><!-- 1..1 Insurance instance identifier --> <focal value="[boolean]"/><!-- 1..1 Coverage to be used for adjudication --> <identifier><!-- 0..1 Identifier Pre-assigned Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Additional provider contract number --> <preAuthRef value="[string]"/><!-- 0..* Prior authorization reference number --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details of the event --> <date value="[date]"/><!-- 1..1 When the incident occurred --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Where the event occurred --></location[x]> </accident> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <item> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careTeam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Product or service billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of service or product delivery --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service or where product was supplied --></location[x]> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <bodySite> <!-- 0..* Anatomical location --> <site><!-- 1..* CodeableReference(BodyStructure) Location --></site> <subSite><!-- 0..* CodeableConcept Sub-location --></subSite> </bodySite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <detail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <subDetail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </subDetail> </detail> </item> <total><!-- 0..1 Money Total claim cost --></total> </Claim>
JSON Template
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Business Identifier for claim "status" : "<code>", // R! active | cancelled | draft | entered-in-error "type" : { CodeableConcept }, // R! Category or discipline "subType" : { CodeableConcept }, // More granular claim type "use" : "<code>", // R! claim | preauthorization | predetermination "patient" : { Reference(Patient) }, // R! The recipient of the products and services "billablePeriod" : { Period }, // Relevant time frame for the claim "created" : "<dateTime>", // R! Resource creation date "enterer" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Author of the claim "insurer" : { Reference(Organization) }, // Target "provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Party responsible for the claim "priority" : { CodeableConcept }, // Desired processing urgency "fundsReserve" : { CodeableConcept }, // For whom to reserve funds "related" : [{ // Prior or corollary claims "claim" : { Reference(Claim) }, // Reference to the related claim "relationship" : { CodeableConcept }, // How the reference claim is related "reference" : { Identifier } // File or case reference }], "prescription" : { Reference(DeviceRequest|MedicationRequest| VisionPrescription) }, // Prescription authorizing services and products "originalPrescription" : { Reference(DeviceRequest|MedicationRequest| VisionPrescription) }, // Original prescription if superseded by fulfiller "payee" : { // Recipient of benefits payable "type" : { CodeableConcept }, // R! Category of recipient "party" : { Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) } // Recipient reference }, "referral" : { Reference(ServiceRequest) }, // Treatment referral "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "facility" : { Reference(Location|Organization) }, // Servicing facility "diagnosisRelatedGroup" : { CodeableConcept }, // Package billing code "careTeam" : [{ // Members of the care team "sequence" : "<positiveInt>", // R! Order of care team "provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // R! Practitioner or organization "responsible" : <boolean>, // Indicator of the lead practitioner "role" : { CodeableConcept }, // Function within the team "specialty" : { CodeableConcept } // Practitioner or provider specialization }], "supportingInfo" : [{ // Supporting information "sequence" : "<positiveInt>", // R! Information instance identifier "category" : { CodeableConcept }, // R! Classification of the supplied information "code" : { CodeableConcept }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Data to be provided. One of these 6: "valueBoolean" : <boolean>, "valueString" : "<string>", "valueQuantity" : { Quantity }, "valueAttachment" : { Attachment }, "valueReference" : { Reference(Any) }, "valueIdentifier" : { Identifier }, "reason" : { CodeableConcept } // Explanation for the information }], "diagnosis" : [{ // Pertinent diagnosis information "sequence" : "<positiveInt>", // R! Diagnosis instance identifier // diagnosis[x]: Nature of illness or problem. One of these 2: "diagnosisCodeableConcept" : { CodeableConcept }, "diagnosisReference" : { Reference(Condition) }, "type" : [{ CodeableConcept }], // Timing or nature of the diagnosis "onAdmission" : { CodeableConcept } // Present on admission }], "procedure" : [{ // Clinical procedures performed "sequence" : "<positiveInt>", // R! Procedure instance identifier "type" : [{ CodeableConcept }], // Category of Procedure "date" : "<dateTime>", // When the procedure was performed // procedure[x]: Specific clinical procedure. One of these 2: "procedureCodeableConcept" : { CodeableConcept }, "procedureReference" : { Reference(Procedure) }, "udi" : [{ Reference(Device) }] // Unique device identifier }], "insurance" : [{ // Patient insurance information "sequence" : "<positiveInt>", // R! Insurance instance identifier "focal" : <boolean>, // R! Coverage to be used for adjudication "identifier" : { Identifier }, // Pre-assigned Claim number "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Additional provider contract number "preAuthRef" : ["<string>"], // Prior authorization reference number "claimResponse" : { Reference(ClaimResponse) } // Adjudication results }], "accident" : { // Details of the event "date" : "<date>", // R! When the incident occurred "type" : { CodeableConcept }, // The nature of the accident // location[x]: Where the event occurred. One of these 2: "locationAddress" : { Address }, "locationReference" : { Reference(Location) } }, "patientPaid" : { Money }, // Paid by the patient "item" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "careTeamSequence" : ["<positiveInt>"], // Applicable careTeam members "diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses "procedureSequence" : ["<positiveInt>"], // Applicable procedures "informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Product or service billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under // serviced[x]: Date or dates of service or product delivery. One of these 2: "servicedDate" : "<date>", "servicedPeriod" : { Period }, // location[x]: Place of service or where product was supplied. One of these 3: "locationCodeableConcept" : { CodeableConcept }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique device identifier "bodySite" : [{ // Anatomical location "site" : [{ CodeableReference(BodyStructure) }], // R! Location "subSite" : [{ CodeableConcept }] // Sub-location }], "encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item "detail" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }], // Unique device identifier "subDetail" : [{ // Product or service provided "sequence" : "<positiveInt>", // R! Item instance identifier "revenue" : { CodeableConcept }, // Revenue or cost center code "category" : { CodeableConcept }, // Benefit classification "productOrService" : { CodeableConcept }, // Billing, service, product, or drug code "productOrServiceEnd" : { CodeableConcept }, // End of a range of codes "modifier" : [{ CodeableConcept }], // Service/Product billing modifiers "programCode" : [{ CodeableConcept }], // Program the product or service is provided under "patientPaid" : { Money }, // Paid by the patient "quantity" : { Quantity(SimpleQuantity) }, // Count of products or services "unitPrice" : { Money }, // Fee, charge or cost per item "factor" : <decimal>, // Price scaling factor "tax" : { Money }, // Total tax "net" : { Money }, // Total item cost "udi" : [{ Reference(Device) }] // Unique device identifier }] }] }], "total" : { Money } // Total claim cost }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Claim.identifier [ Identifier ], ... ; # 0..* Business Identifier for claim fhir:Claim.status [ code ]; # 1..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ CodeableConcept ]; # 1..1 Category or discipline fhir:Claim.subType [ CodeableConcept ]; # 0..1 More granular claim type fhir:Claim.use [ code ]; # 1..1 claim | preauthorization | predetermination fhir:Claim.patient [ Reference(Patient) ]; # 1..1 The recipient of the products and services fhir:Claim.billablePeriod [ Period ]; # 0..1 Relevant time frame for the claim fhir:Claim.created [ dateTime ]; # 1..1 Resource creation date fhir:Claim.enterer [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Author of the claim fhir:Claim.insurer [ Reference(Organization) ]; # 0..1 Target fhir:Claim.provider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Party responsible for the claim fhir:Claim.priority [ CodeableConcept ]; # 0..1 Desired processing urgency fhir:Claim.fundsReserve [ CodeableConcept ]; # 0..1 For whom to reserve funds fhir:Claim.related [ # 0..* Prior or corollary claims fhir:Claim.related.claim [ Reference(Claim) ]; # 0..1 Reference to the related claim fhir:Claim.related.relationship [ CodeableConcept ]; # 0..1 How the reference claim is related fhir:Claim.related.reference [ Identifier ]; # 0..1 File or case reference ], ...; fhir:Claim.prescription [ Reference(DeviceRequest|MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services and products fhir:Claim.originalPrescription [ Reference(DeviceRequest|MedicationRequest|VisionPrescription) ]; # 0..1 Original prescription if superseded by fulfiller fhir:Claim.payee [ # 0..1 Recipient of benefits payable fhir:Claim.payee.type [ CodeableConcept ]; # 1..1 Category of recipient fhir:Claim.payee.party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Recipient reference ]; fhir:Claim.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment referral fhir:Claim.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.facility [ Reference(Location|Organization) ]; # 0..1 Servicing facility fhir:Claim.diagnosisRelatedGroup [ CodeableConcept ]; # 0..1 Package billing code fhir:Claim.careTeam [ # 0..* Members of the care team fhir:Claim.careTeam.sequence [ positiveInt ]; # 1..1 Order of care team fhir:Claim.careTeam.provider [ Reference(Organization|Practitioner|PractitionerRole) ]; # 1..1 Practitioner or organization fhir:Claim.careTeam.responsible [ boolean ]; # 0..1 Indicator of the lead practitioner fhir:Claim.careTeam.role [ CodeableConcept ]; # 0..1 Function within the team fhir:Claim.careTeam.specialty [ CodeableConcept ]; # 0..1 Practitioner or provider specialization ], ...; fhir:Claim.supportingInfo [ # 0..* Supporting information fhir:Claim.supportingInfo.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:Claim.supportingInfo.category [ CodeableConcept ]; # 1..1 Classification of the supplied information fhir:Claim.supportingInfo.code [ CodeableConcept ]; # 0..1 Type of information # Claim.supportingInfo.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.supportingInfo.timingDate [ date ] fhir:Claim.supportingInfo.timingPeriod [ Period ] # Claim.supportingInfo.value[x] : 0..1 Data to be provided. One of these 6 fhir:Claim.supportingInfo.valueBoolean [ boolean ] fhir:Claim.supportingInfo.valueString [ string ] fhir:Claim.supportingInfo.valueQuantity [ Quantity ] fhir:Claim.supportingInfo.valueAttachment [ Attachment ] fhir:Claim.supportingInfo.valueReference [ Reference(Any) ] fhir:Claim.supportingInfo.valueIdentifier [ Identifier ] fhir:Claim.supportingInfo.reason [ CodeableConcept ]; # 0..1 Explanation for the information ], ...; fhir:Claim.diagnosis [ # 0..* Pertinent diagnosis information fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Diagnosis instance identifier # Claim.diagnosis.diagnosis[x] : 1..1 Nature of illness or problem. One of these 2 fhir:Claim.diagnosis.diagnosisCodeableConcept [ CodeableConcept ] fhir:Claim.diagnosis.diagnosisReference [ Reference(Condition) ] fhir:Claim.diagnosis.type [ CodeableConcept ], ... ; # 0..* Timing or nature of the diagnosis fhir:Claim.diagnosis.onAdmission [ CodeableConcept ]; # 0..1 Present on admission ], ...; fhir:Claim.procedure [ # 0..* Clinical procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure instance identifier fhir:Claim.procedure.type [ CodeableConcept ], ... ; # 0..* Category of Procedure fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Specific clinical procedure. One of these 2 fhir:Claim.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] fhir:Claim.procedure.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier ], ...; fhir:Claim.insurance [ # 0..* Patient insurance information fhir:Claim.insurance.sequence [ positiveInt ]; # 1..1 Insurance instance identifier fhir:Claim.insurance.focal [ boolean ]; # 1..1 Coverage to be used for adjudication fhir:Claim.insurance.identifier [ Identifier ]; # 0..1 Pre-assigned Claim number fhir:Claim.insurance.coverage [ Reference(Coverage) ]; # 1..1 Insurance information fhir:Claim.insurance.businessArrangement [ string ]; # 0..1 Additional provider contract number fhir:Claim.insurance.preAuthRef [ string ], ... ; # 0..* Prior authorization reference number fhir:Claim.insurance.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results ], ...; fhir:Claim.accident [ # 0..1 Details of the event fhir:Claim.accident.date [ date ]; # 1..1 When the incident occurred fhir:Claim.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Where the event occurred. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ]; fhir:Claim.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item [ # 0..* Product or service provided fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.careTeamSequence [ positiveInt ], ... ; # 0..* Applicable careTeam members fhir:Claim.item.diagnosisSequence [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:Claim.item.procedureSequence [ positiveInt ], ... ; # 0..* Applicable procedures fhir:Claim.item.informationSequence [ positiveInt ], ... ; # 0..* Applicable exception and supporting information fhir:Claim.item.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.modifier [ CodeableConcept ], ... ; # 0..* Product or service billing modifiers fhir:Claim.item.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under # Claim.item.serviced[x] : 0..1 Date or dates of service or product delivery. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service or where product was supplied. One of these 3 fhir:Claim.item.locationCodeableConcept [ CodeableConcept ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] fhir:Claim.item.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier fhir:Claim.item.bodySite [ # 0..* Anatomical location fhir:Claim.item.bodySite.site [ CodeableReference(BodyStructure) ], ... ; # 1..* Location fhir:Claim.item.bodySite.subSite [ CodeableConcept ], ... ; # 0..* Sub-location ], ...; fhir:Claim.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.item.detail [ # 0..* Product or service provided fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.detail.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.detail.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under fhir:Claim.item.detail.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.detail.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier fhir:Claim.item.detail.subDetail [ # 0..* Product or service provided fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Item instance identifier fhir:Claim.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Benefit classification fhir:Claim.item.detail.subDetail.productOrService [ CodeableConcept ]; # 0..1 Billing, service, product, or drug code fhir:Claim.item.detail.subDetail.productOrServiceEnd [ CodeableConcept ]; # 0..1 End of a range of codes fhir:Claim.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program the product or service is provided under fhir:Claim.item.detail.subDetail.patientPaid [ Money ]; # 0..1 Paid by the patient fhir:Claim.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of products or services fhir:Claim.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per item fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.tax [ Money ]; # 0..1 Total tax fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique device identifier ], ...; ], ...; ], ...; fhir:Claim.total [ Money ]; # 0..1 Total claim cost ]
Changes since Release 4
Claim | |
Claim.enterer |
|
Claim.provider |
|
Claim.priority |
|
Claim.encounter |
|
Claim.facility |
|
Claim.diagnosisRelatedGroup |
|
Claim.careTeam.specialty |
|
Claim.supportingInfo.value[x] |
|
Claim.insurance |
|
Claim.patientPaid |
|
Claim.item.productOrService |
|
Claim.item.productOrServiceEnd |
|
Claim.item.patientPaid |
|
Claim.item.tax |
|
Claim.item.bodySite |
|
Claim.item.bodySite.site |
|
Claim.item.bodySite.subSite |
|
Claim.item.detail.productOrService |
|
Claim.item.detail.productOrServiceEnd |
|
Claim.item.detail.patientPaid |
|
Claim.item.detail.tax |
|
Claim.item.detail.subDetail.productOrService |
|
Claim.item.detail.subDetail.productOrServiceEnd |
|
Claim.item.detail.subDetail.patientPaid |
|
Claim.item.detail.subDetail.tax |
|
Claim.careTeam.qualification |
|
Claim.diagnosis.packageCode |
|
Claim.item.subSite |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 16 tests of which 3 fail to execute. 13 fail round-trip testing and 3 r3 resources are invalid (0 errors).)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
Claim.status | This value set includes Status codes. | Required | FinancialResourceStatusCodes |
Claim.type | This value set includes Claim Type codes. | Extensible | ClaimTypeCodes |
Claim.subType | This value set includes sample Claim SubType codes which are used to distinguish the claim types for example within type institutional there may be subtypes for emergency services, bed stay and transportation. | Example | ExampleClaimSubTypeCodes |
Claim.use | The purpose of the Claim: predetermination, preauthorization, claim. | Required | Use |
Claim.priority | This value set includes the financial processing priority codes. | Example | ProcessPriorityCodes |
Claim.fundsReserve | This value set includes sample funds reservation type codes. | Example | Funds Reservation Codes |
Claim.related.relationship | This value set includes sample Related Claim Relationship codes. | Example | ExampleRelatedClaimRelationshipCodes |
Claim.payee.type | This value set includes sample Payee Type codes. | Example | Claim Payee Type Codes |
Claim.diagnosisRelatedGroup | This value set includes example Diagnosis Related Group codes. | Example | ExampleDiagnosisRelatedGroupCodes |
Claim.careTeam.role | This value set includes sample Claim Care Team Role codes. | Example | ClaimCareTeamRoleCodes |
Claim.careTeam.specialty | This value set includes sample Provider Qualification codes. | Example | ExampleProviderQualificationCodes |
Claim.supportingInfo.category | This value set includes sample Information Category codes. | Example | ClaimInformationCategoryCodes |
Claim.supportingInfo.code | This value set includes sample Exception codes. | Example | ExceptionCodes |
Claim.supportingInfo.reason | This value set includes sample Missing Tooth Reason codes. | Example | MissingToothReasonCodes |
Claim.diagnosis.diagnosis[x] | This value set includes sample ICD-10 codes. | Example | ICD-10Codes |
Claim.diagnosis.type | This value set includes example Diagnosis Type codes. | Example | ExampleDiagnosisTypeCodes |
Claim.diagnosis.onAdmission | This value set includes example Diagnosis on Admission codes. | Example | ExampleDiagnosisOnAdmissionCodes |
Claim.procedure.type | This value set includes example Procedure Type codes. | Example | ExampleProcedureTypeCodes |
Claim.procedure.procedure[x] | This value set includes sample ICD-10 Procedure codes. | Example | ICD-10ProcedureCodes |
Claim.accident.type | Set of codes indicating the type of incident or accident. | Extensible | ActIncidentCode |
Claim.item.revenue | This value set includes sample Revenue Center codes. | Example | ExampleRevenueCenterCodes |
Claim.item.category | This value set includes examples of Benefit Category codes. | Example | BenefitCategoryCodes |
Claim.item.productOrService | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.productOrServiceEnd | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.modifier | This value set includes sample Modifier type codes. | Example | ModifierTypeCodes |
Claim.item.programCode | This value set includes sample Program Reason Span codes. | Example | ExampleProgramReasonCodes |
Claim.item.location[x] | This value set includes a smattering of Service Place codes. | Example | ExampleServicePlaceCodes |
Claim.item.bodySite.site | This value set includes a smattering of FDI oral site codes. | Example | OralSiteCodes |
Claim.item.bodySite.subSite | This value set includes a smattering of FDI tooth surface codes. | Example | SurfaceCodes |
Claim.item.detail.revenue | This value set includes sample Revenue Center codes. | Example | ExampleRevenueCenterCodes |
Claim.item.detail.category | This value set includes examples of Benefit Category codes. | Example | BenefitCategoryCodes |
Claim.item.detail.productOrService | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.detail.productOrServiceEnd | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.detail.modifier | This value set includes sample Modifier type codes. | Example | ModifierTypeCodes |
Claim.item.detail.programCode | This value set includes sample Program Reason Span codes. | Example | ExampleProgramReasonCodes |
Claim.item.detail.subDetail.revenue | This value set includes sample Revenue Center codes. | Example | ExampleRevenueCenterCodes |
Claim.item.detail.subDetail.category | This value set includes examples of Benefit Category codes. | Example | BenefitCategoryCodes |
Claim.item.detail.subDetail.productOrService | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.detail.subDetail.productOrServiceEnd | This value set includes a smattering of USCLS codes. | Example | USCLSCodes |
Claim.item.detail.subDetail.modifier | This value set includes sample Modifier type codes. | Example | ModifierTypeCodes |
Claim.item.detail.subDetail.programCode | This value set includes sample Program Reason Span codes. | Example | ExampleProgramReasonCodes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
care-team | reference | Member of the CareTeam | Claim.careTeam.provider (Practitioner, Organization, PractitionerRole) | |
created N | date | The creation date for the Claim | Claim.created | |
detail-udi | reference | UDI associated with a line item, detail product or service | Claim.item.detail.udi (Device) | |
encounter | reference | Encounters associated with a billed line item | Claim.item.encounter (Encounter) | |
enterer | reference | The party responsible for the entry of the Claim | Claim.enterer (Practitioner, Patient, PractitionerRole, RelatedPerson) | |
facility | reference | Facility where the products or services have been or will be provided | Claim.facility (Organization, Location) | |
identifier | token | The primary identifier of the financial resource | Claim.identifier | |
insurer | reference | The target payor/insurer for the Claim | Claim.insurer (Organization) | |
item-udi | reference | UDI associated with a line item product or service | Claim.item.udi (Device) | |
patient | reference | Patient receiving the products or services | Claim.patient (Patient) | |
payee | reference | The party receiving any payment for the Claim | Claim.payee.party (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | |
priority | token | Processing priority requested | Claim.priority | |
procedure-udi | reference | UDI associated with a procedure | Claim.procedure.udi (Device) | |
provider | reference | Provider responsible for the Claim | Claim.provider (Practitioner, Organization, PractitionerRole) | |
status N | token | The status of the Claim instance. | Claim.status | |
subdetail-udi | reference | UDI associated with a line item, detail, subdetail product or service | Claim.item.detail.subDetail.udi (Device) | |
use N | token | The kind of financial resource | Claim.use |