This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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: 0 | Compartments: Patient, Practitioner |
A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
The OralHealthClaim is one of a suite of similar resources (VisionClaim, PharmacyClaim, ProfessionalClaim, InstitutionalClaim) which are used by providers to exchange the financial information, and supporting clinical information, regarding the provision of healthcare services. The primary uses of this resource is to support eClaims, the exchange of proposed or actual services to benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
The Claim is intended to support:
The Claim also supports:
Todo
This resource is referenced by ClaimResponse and ExplanationOfBenefit
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | Σ | DomainResource | Claim, Pre-determination or Pre-authorization | |
type | Σ | 1..1 | code | institutional | oral | pharmacy | professional | vision ClaimType (Required) |
identifier | Σ | 0..* | Identifier | Claim number |
ruleset | Σ | 0..1 | Coding | Current specification followed Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original specification followed Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
target | Σ | 0..1 | Reference(Organization) | Insurer |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible provider |
organization | Σ | 0..1 | Reference(Organization) | Responsible organization |
use | Σ | 0..1 | code | complete | proposed | exploratory | other Use (Required) |
priority | Σ | 0..1 | Coding | Desired processing priority Priority Codes (Example) |
fundsReserve | Σ | 0..1 | Coding | Funds requested to be reserved Funds Reservation Codes (Example) |
enterer | Σ | 0..1 | Reference(Practitioner) | Author |
facility | Σ | 0..1 | Reference(Location) | Servicing Facility |
prescription | Σ | 0..1 | Reference(MedicationOrder | VisionPrescription) | Prescription |
originalPrescription | Σ | 0..1 | Reference(MedicationOrder) | Original Prescription |
payee | Σ | 0..1 | BackboneElement | Payee |
type | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee type Codes (Example) |
provider | Σ | 0..1 | Reference(Practitioner) | Provider who is the payee |
organization | Σ | 0..1 | Reference(Organization) | Organization who is the payee |
person | Σ | 0..1 | Reference(Patient) | Other person who is the payee |
referral | Σ | 0..1 | Reference(ReferralRequest) | Treatment Referral |
diagnosis | Σ | 0..* | BackboneElement | Diagnosis |
sequence | Σ | 1..1 | positiveInt | Sequence of diagnosis |
diagnosis | Σ | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) |
condition | Σ | 0..* | Coding | List of presenting Conditions Conditions Codes (Example) |
patient | Σ | 1..1 | Reference(Patient) | The subject of the Products and Services |
coverage | Σ | 0..* | BackboneElement | Insurance or medical plan |
sequence | Σ | 1..1 | positiveInt | Service instance identifier |
focal | Σ | 1..1 | boolean | Is the focal Coverage |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
businessArrangement | Σ | 0..1 | string | Business agreement |
relationship | Σ | 1..1 | Coding | Patient relationship to subscriber Surface Codes (Example) |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Adjudication results |
originalRuleset | Σ | 0..1 | Coding | Original version Ruleset Codes (Example) |
exception | Σ | 0..* | Coding | Eligibility exceptions Exception Codes (Example) |
school | Σ | 0..1 | string | Name of School |
accident | Σ | 0..1 | date | Accident Date |
accidentType | Σ | 0..1 | Coding | Accident Type ActIncidentCode (Required) |
interventionException | Σ | 0..* | Coding | Intervention and exception code (Pharma) Intervention Codes (Example) |
item | Σ | 0..* | BackboneElement | Goods and Services |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible practitioner |
diagnosisLinkId | Σ | 0..* | positiveInt | Diagnosis Link |
service | Σ | 1..1 | Coding | Item Code USCLS Codes (Example) |
serviceDate | Σ | 0..1 | date | Date of Service |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
bodySite | Σ | 0..1 | Coding | Service Location Surface Codes (Example) |
subSite | Σ | 0..* | Coding | Service Sub-location Surface Codes (Example) |
modifier | Σ | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) |
detail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
subDetail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Net additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
prosthesis | Σ | 0..1 | BackboneElement | Prosthetic details |
initial | Σ | 0..1 | boolean | Is this the initial service |
priorDate | Σ | 0..1 | date | Initial service Date |
priorMaterial | Σ | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) |
additionalMaterials | Σ | 0..* | Coding | Additional materials, documents, etc. Additional Material Codes (Example) |
missingTeeth | Σ | 0..* | BackboneElement | Only if type = oral |
tooth | Σ | 1..1 | Coding | Tooth Code Teeth Codes (Example) |
reason | Σ | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) |
extractionDate | Σ | 0..1 | date | Date of Extraction |
Documentation for this format |
UML Diagram
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <type value="[code]"/><!-- 1..1 institutional | oral | pharmacy | professional | vision --> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization) Insurer --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible provider --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <enterer><!-- 0..1 Reference(Practitioner) Author --></enterer> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <prescription><!-- 0..1 Reference(MedicationOrder|VisionPrescription) Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationOrder) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <condition><!-- 0..* Coding List of presenting Conditions --></condition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accident value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviceDate value="[date]"/><!-- 0..1 Date of Service --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <additionalMaterials><!-- 0..* Coding Additional materials, documents, etc. --></additionalMaterials> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> </Claim>
JSON Template
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "type" : "<code>", // R! institutional | oral | pharmacy | professional | vision "identifier" : [{ Identifier }], // Claim number "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "target" : { Reference(Organization) }, // Insurer "provider" : { Reference(Practitioner) }, // Responsible provider "organization" : { Reference(Organization) }, // Responsible organization "use" : "<code>", // complete | proposed | exploratory | other "priority" : { Coding }, // Desired processing priority "fundsReserve" : { Coding }, // Funds requested to be reserved "enterer" : { Reference(Practitioner) }, // Author "facility" : { Reference(Location) }, // Servicing Facility "prescription" : { Reference(MedicationOrder|VisionPrescription) }, // Prescription "originalPrescription" : { Reference(MedicationOrder) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "condition" : [{ Coding }], // List of presenting Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "coverage" : [{ // Insurance or medical plan "sequence" : "<positiveInt>", // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Business agreement "relationship" : { Coding }, // R! Patient relationship to subscriber "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results "originalRuleset" : { Coding } // Original version }], "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accident" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : ["<positiveInt>"], // Diagnosis Link "service" : { Coding }, // R! Item Code "serviceDate" : "<date>", // Date of Service "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Net additional item cost "udi" : { Coding } // Unique Device Identifier }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "additionalMaterials" : [{ Coding }], // Additional materials, documents, etc. "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | Σ | DomainResource | Claim, Pre-determination or Pre-authorization | |
type | Σ | 1..1 | code | institutional | oral | pharmacy | professional | vision ClaimType (Required) |
identifier | Σ | 0..* | Identifier | Claim number |
ruleset | Σ | 0..1 | Coding | Current specification followed Ruleset Codes (Example) |
originalRuleset | Σ | 0..1 | Coding | Original specification followed Ruleset Codes (Example) |
created | Σ | 0..1 | dateTime | Creation date |
target | Σ | 0..1 | Reference(Organization) | Insurer |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible provider |
organization | Σ | 0..1 | Reference(Organization) | Responsible organization |
use | Σ | 0..1 | code | complete | proposed | exploratory | other Use (Required) |
priority | Σ | 0..1 | Coding | Desired processing priority Priority Codes (Example) |
fundsReserve | Σ | 0..1 | Coding | Funds requested to be reserved Funds Reservation Codes (Example) |
enterer | Σ | 0..1 | Reference(Practitioner) | Author |
facility | Σ | 0..1 | Reference(Location) | Servicing Facility |
prescription | Σ | 0..1 | Reference(MedicationOrder | VisionPrescription) | Prescription |
originalPrescription | Σ | 0..1 | Reference(MedicationOrder) | Original Prescription |
payee | Σ | 0..1 | BackboneElement | Payee |
type | Σ | 0..1 | Coding | Party to be paid any benefits payable Payee type Codes (Example) |
provider | Σ | 0..1 | Reference(Practitioner) | Provider who is the payee |
organization | Σ | 0..1 | Reference(Organization) | Organization who is the payee |
person | Σ | 0..1 | Reference(Patient) | Other person who is the payee |
referral | Σ | 0..1 | Reference(ReferralRequest) | Treatment Referral |
diagnosis | Σ | 0..* | BackboneElement | Diagnosis |
sequence | Σ | 1..1 | positiveInt | Sequence of diagnosis |
diagnosis | Σ | 1..1 | Coding | Patient's list of diagnosis ICD-10 Codes (Example) |
condition | Σ | 0..* | Coding | List of presenting Conditions Conditions Codes (Example) |
patient | Σ | 1..1 | Reference(Patient) | The subject of the Products and Services |
coverage | Σ | 0..* | BackboneElement | Insurance or medical plan |
sequence | Σ | 1..1 | positiveInt | Service instance identifier |
focal | Σ | 1..1 | boolean | Is the focal Coverage |
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
businessArrangement | Σ | 0..1 | string | Business agreement |
relationship | Σ | 1..1 | Coding | Patient relationship to subscriber Surface Codes (Example) |
preAuthRef | Σ | 0..* | string | Pre-Authorization/Determination Reference |
claimResponse | Σ | 0..1 | Reference(ClaimResponse) | Adjudication results |
originalRuleset | Σ | 0..1 | Coding | Original version Ruleset Codes (Example) |
exception | Σ | 0..* | Coding | Eligibility exceptions Exception Codes (Example) |
school | Σ | 0..1 | string | Name of School |
accident | Σ | 0..1 | date | Accident Date |
accidentType | Σ | 0..1 | Coding | Accident Type ActIncidentCode (Required) |
interventionException | Σ | 0..* | Coding | Intervention and exception code (Pharma) Intervention Codes (Example) |
item | Σ | 0..* | BackboneElement | Goods and Services |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
provider | Σ | 0..1 | Reference(Practitioner) | Responsible practitioner |
diagnosisLinkId | Σ | 0..* | positiveInt | Diagnosis Link |
service | Σ | 1..1 | Coding | Item Code USCLS Codes (Example) |
serviceDate | Σ | 0..1 | date | Date of Service |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
bodySite | Σ | 0..1 | Coding | Service Location Surface Codes (Example) |
subSite | Σ | 0..* | Coding | Service Sub-location Surface Codes (Example) |
modifier | Σ | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) |
detail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Group or type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Total additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
subDetail | Σ | 0..* | BackboneElement | Additional items |
sequence | Σ | 1..1 | positiveInt | Service instance |
type | Σ | 1..1 | Coding | Type of product or service ActInvoiceGroupCode (Required) |
service | Σ | 1..1 | Coding | Additional item codes USCLS Codes (Example) |
quantity | Σ | 0..1 | SimpleQuantity | Count of Products or Services |
unitPrice | Σ | 0..1 | Money | Fee, charge or cost per point |
factor | Σ | 0..1 | decimal | Price scaling factor |
points | Σ | 0..1 | decimal | Difficulty scaling factor |
net | Σ | 0..1 | Money | Net additional item cost |
udi | Σ | 0..1 | Coding | Unique Device Identifier UDI Codes (Example) |
prosthesis | Σ | 0..1 | BackboneElement | Prosthetic details |
initial | Σ | 0..1 | boolean | Is this the initial service |
priorDate | Σ | 0..1 | date | Initial service Date |
priorMaterial | Σ | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) |
additionalMaterials | Σ | 0..* | Coding | Additional materials, documents, etc. Additional Material Codes (Example) |
missingTeeth | Σ | 0..* | BackboneElement | Only if type = oral |
tooth | Σ | 1..1 | Coding | Tooth Code Teeth Codes (Example) |
reason | Σ | 0..1 | Coding | Reason for missing Missing Tooth Reason Codes (Example) |
extractionDate | Σ | 0..1 | date | Date of Extraction |
Documentation for this format |
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <type value="[code]"/><!-- 1..1 institutional | oral | pharmacy | professional | vision --> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization) Insurer --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible provider --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <enterer><!-- 0..1 Reference(Practitioner) Author --></enterer> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <prescription><!-- 0..1 Reference(MedicationOrder|VisionPrescription) Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationOrder) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <condition><!-- 0..* Coding List of presenting Conditions --></condition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accident value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviceDate value="[date]"/><!-- 0..1 Date of Service --> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item> <additionalMaterials><!-- 0..* Coding Additional materials, documents, etc. --></additionalMaterials> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <reason><!-- 0..1 Coding Reason for missing --></reason> <extractionDate value="[date]"/><!-- 0..1 Date of Extraction --> </missingTeeth> </Claim>
JSON Template
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "type" : "<code>", // R! institutional | oral | pharmacy | professional | vision "identifier" : [{ Identifier }], // Claim number "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "target" : { Reference(Organization) }, // Insurer "provider" : { Reference(Practitioner) }, // Responsible provider "organization" : { Reference(Organization) }, // Responsible organization "use" : "<code>", // complete | proposed | exploratory | other "priority" : { Coding }, // Desired processing priority "fundsReserve" : { Coding }, // Funds requested to be reserved "enterer" : { Reference(Practitioner) }, // Author "facility" : { Reference(Location) }, // Servicing Facility "prescription" : { Reference(MedicationOrder|VisionPrescription) }, // Prescription "originalPrescription" : { Reference(MedicationOrder) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "condition" : [{ Coding }], // List of presenting Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "coverage" : [{ // Insurance or medical plan "sequence" : "<positiveInt>", // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Business agreement "relationship" : { Coding }, // R! Patient relationship to subscriber "preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results "originalRuleset" : { Coding } // Original version }], "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accident" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : ["<positiveInt>"], // Diagnosis Link "service" : { Coding }, // R! Item Code "serviceDate" : "<date>", // Date of Service "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subSite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "detail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Quantity(Money) }, // Net additional item cost "udi" : { Coding } // Unique Device Identifier }] }], "prosthesis" : { // Prosthetic details "initial" : <boolean>, // Is this the initial service "priorDate" : "<date>", // Initial service Date "priorMaterial" : { Coding } // Prosthetic Material } }], "additionalMaterials" : [{ Coding }], // Additional materials, documents, etc. "missingTeeth" : [{ // Only if type = oral "tooth" : { Coding }, // R! Tooth Code "reason" : { Coding }, // Reason for missing "extractionDate" : "<date>" // Date of Extraction }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
Claim.type | The type or discipline-style of the claim | Required | ClaimType |
Claim.ruleset Claim.originalRuleset Claim.coverage.originalRuleset | The static and dynamic model to which contents conform, may be business version or standard and version. | Example | Ruleset Codes |
Claim.use | Complete, proposed, exploratory, other | Required | Use |
Claim.priority | The timeliness with which processing is required: STAT, normal, Deferred | Example | Priority Codes |
Claim.fundsReserve | For whom funds are to be reserved: (Patient, Provider, None) | Example | Funds Reservation Codes |
Claim.payee.type | A code for the party to be reimbursed. | Example | Payee type Codes |
Claim.diagnosis.diagnosis | ICD10 Diagnostic codes | Example | ICD-10 Codes |
Claim.condition | Patient conditions and symptoms | Example | Conditions Codes |
Claim.coverage.relationship | The code for the relationship of the patient to the subscriber | Example | Surface Codes |
Claim.exception | The eligibility exception codes. | Example | Exception Codes |
Claim.accidentType | Type of accident: work place, auto, etc. | Required | ActIncidentCode |
Claim.interventionException | Intervention and exception codes (Pharm) | Example | Intervention Codes |
Claim.item.type Claim.item.detail.type Claim.item.detail.subDetail.type | Service, Product, Rx Dispense, Rx Compound etc. | Required | ActInvoiceGroupCode |
Claim.item.service Claim.item.detail.service Claim.item.detail.subDetail.service | Allowable service and product codes | Example | USCLS Codes |
Claim.item.udi Claim.item.detail.udi Claim.item.detail.subDetail.udi | The FDA, or other, UDI repository. | Example | UDI Codes |
Claim.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example | Surface Codes |
Claim.item.subSite | The code for the tooth surface and surface combinations | Example | Surface Codes |
Claim.item.modifier | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | Example | Modifier type Codes |
Claim.item.prosthesis.priorMaterial | Material of the prior denture or bridge prosthesis. (Oral) | Example | Oral Prostho Material type Codes |
Claim.additionalMaterials | Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission. | Example | Additional Material Codes |
Claim.missingTeeth.tooth | The codes for the teeth, subset of OralSites | Example | Teeth Codes |
Claim.missingTeeth.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
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 | Paths |
identifier | token | The primary identifier of the financial resource | Claim.identifier |
patient | reference | Patient | Claim.patient (Patient) |
priority | token | Processing priority requested | Claim.priority |
provider | reference | Provider responsible for the claim | Claim.provider (Practitioner) |
use | token | The kind of financial resource | Claim.use |