This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
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
|
|---|---|---|---|---|
|
Σ | DomainResource | Claim, Pre-determination or Pre-authorization | |
|
Σ | 1..1 | code |
institutional
|
oral
|
pharmacy
|
professional
|
vision
ClaimType ( Required ) |
|
Σ | 0..* | Identifier | Claim number |
|
Σ | 0..1 | Coding |
Current
specification
followed
Ruleset Codes ( Example ) |
|
Σ | 0..1 | Coding |
Original
specification
followed
Ruleset Codes ( Example ) |
|
Σ | 0..1 | dateTime | Creation date |
|
Σ | 0..1 | Reference ( Organization ) | Insurer |
|
Σ | 0..1 | Reference ( Practitioner ) | Responsible provider |
|
Σ | 0..1 | Reference ( Organization ) | Responsible organization |
|
Σ | 0..1 | code |
complete
|
proposed
|
exploratory
|
other
Use ( Required ) |
|
Σ | 0..1 | Coding |
Desired
processing
priority
|
|
Σ | 0..1 | Coding |
Funds
requested
to
be
reserved
|
|
Σ | 0..1 | Reference ( Practitioner ) | Author |
|
Σ | 0..1 | Reference ( Location ) | Servicing Facility |
|
Σ | 0..1 |
|
Prescription |
|
Σ | 0..1 |
|
Original Prescription |
|
Σ | 0..1 |
|
Payee |
|
Σ | 0..1 | Coding |
Party
to
be
paid
any
benefits
payable
|
|
Σ | 0..1 | Reference ( Practitioner ) | Provider who is the payee |
|
Σ | 0..1 | Reference ( Organization ) | Organization who is the payee |
|
Σ | 0..1 | Reference ( Patient ) | Other person who is the payee |
|
Σ | 0..1 | Reference ( ReferralRequest ) | Treatment Referral |
|
Σ | 0..* |
|
Diagnosis |
|
Σ | 1..1 |
|
Sequence of diagnosis |
|
Σ | 1..1 | Coding |
Patient's
list
of
diagnosis
|
|
Σ | 0..* | Coding |
List
of
presenting
Conditions
Conditions Codes ( Example ) |
|
Σ | 1..1 | Reference ( Patient ) | The subject of the Products and Services |
|
Σ | 0..* |
|
Insurance or medical plan |
|
Σ | 1..1 |
|
Service instance identifier |
|
Σ | 1..1 | boolean | The focal Coverage |
|
Σ | 1..1 | Reference ( Coverage ) | Insurance information |
|
Σ | 0..1 | string | Business agreement |
|
Σ | 1..1 | Coding |
Patient
relationship
to
subscriber
|
|
Σ | 0..* | string | Pre-Authorization/Determination Reference |
|
Σ | 0..1 | Reference ( ClaimResponse ) | Adjudication results |
|
Σ | 0..1 | Coding |
Original
version
Ruleset Codes ( Example ) |
|
Σ | 0..* | Coding |
Eligibility
exceptions
Exception Codes ( Example ) |
|
Σ | 0..1 | string | Name of School |
|
Σ | 0..1 | date | Accident Date |
|
Σ | 0..1 | Coding |
Accident
Type
|
|
Σ | 0..* | Coding |
Intervention
and
exception
code
(Pharma)
Intervention Codes ( Example ) |
|
Σ | 0..* |
|
Goods and Services |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Group
or
type
of
product
or
service
|
|
Σ | 0..1 | Reference ( Practitioner ) | Responsible practitioner |
|
Σ | 0..* |
|
Diagnosis Link |
|
Σ | 1..1 | Coding |
Item
Code
|
|
Σ | 0..1 | date | Date of Service |
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Total item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..1 | Coding |
Service
Location
|
|
Σ | 0..* | Coding |
Service
Sub-location
Surface Codes ( Example ) |
|
Σ | 0..* | Coding |
Service/Product
billing
modifiers
|
|
Σ | 0..* |
|
Additional items |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Group
or
type
of
product
or
service
|
|
Σ | 1..1 | Coding |
Additional
item
codes
|
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Total additional item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..* |
|
Additional items |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Type
of
product
or
service
|
|
Σ | 1..1 | Coding |
Additional
item
codes
|
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Net additional item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..1 |
|
Prosthetic details |
|
Σ | 0..1 | boolean | Is this the initial service |
|
Σ | 0..1 | date | Initial service Date |
|
Σ | 0..1 | Coding |
Prosthetic
Material
|
|
Σ | 0..* | Coding |
Additional
materials,
documents,
etc.
|
|
Σ | 0..* |
|
Only if type = oral |
|
Σ | 1..1 | Coding |
Tooth
Code
|
|
Σ | 0..1 | Coding |
Reason
for
missing
|
|
Σ | 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 -->
< <</identifier><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>< <</target> <</provider> <</organization> < <</priority><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> <</facility> < Prescription</prescription> < Original Prescription</originalPrescription><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> <</organization> <</person><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><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><patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan -->< < <</coverage> <<sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 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>< <</claimResponse><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> < < <</accidentType><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 -->< <</type> <</provider> <<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>< <</quantity> <</unitPrice> < < <</net><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> <</subSite> <</modifier><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 -->< <</type><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> <</unitPrice> < < <</net><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 -->< <</type> <</service> <</quantity> <</unitPrice> < < <</net><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
"
"
"
Prescription
"
Original Prescription
"
"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! 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
|
|---|---|---|---|---|
|
Σ | DomainResource | Claim, Pre-determination or Pre-authorization | |
|
Σ | 1..1 | code |
institutional
|
oral
|
pharmacy
|
professional
|
vision
ClaimType ( Required ) |
|
Σ | 0..* | Identifier | Claim number |
|
Σ | 0..1 | Coding |
Current
specification
followed
Ruleset Codes ( Example ) |
|
Σ | 0..1 | Coding |
Original
specification
followed
Ruleset Codes ( Example ) |
|
Σ | 0..1 | dateTime | Creation date |
|
Σ | 0..1 | Reference ( Organization ) | Insurer |
|
Σ | 0..1 | Reference ( Practitioner ) | Responsible provider |
|
Σ | 0..1 | Reference ( Organization ) | Responsible organization |
|
Σ | 0..1 | code |
complete
|
proposed
|
exploratory
|
other
Use ( Required ) |
|
Σ | 0..1 | Coding |
Desired
processing
priority
|
|
Σ | 0..1 | Coding |
Funds
requested
to
be
reserved
|
|
Σ | 0..1 | Reference ( Practitioner ) | Author |
|
Σ | 0..1 | Reference ( Location ) | Servicing Facility |
|
Σ | 0..1 |
|
Prescription |
|
Σ | 0..1 |
|
Original Prescription |
|
Σ | 0..1 |
|
Payee |
|
Σ | 0..1 | Coding |
Party
to
be
paid
any
benefits
payable
|
|
Σ | 0..1 | Reference ( Practitioner ) | Provider who is the payee |
|
Σ | 0..1 | Reference ( Organization ) | Organization who is the payee |
|
Σ | 0..1 | Reference ( Patient ) | Other person who is the payee |
|
Σ | 0..1 | Reference ( ReferralRequest ) | Treatment Referral |
|
Σ | 0..* |
|
Diagnosis |
|
Σ | 1..1 |
|
Sequence of diagnosis |
|
Σ | 1..1 | Coding |
Patient's
list
of
diagnosis
|
|
Σ | 0..* | Coding |
List
of
presenting
Conditions
Conditions Codes ( Example ) |
|
Σ | 1..1 | Reference ( Patient ) | The subject of the Products and Services |
|
Σ | 0..* |
|
Insurance or medical plan |
|
Σ | 1..1 |
|
Service instance identifier |
|
Σ | 1..1 | boolean | The focal Coverage |
|
Σ | 1..1 | Reference ( Coverage ) | Insurance information |
|
Σ | 0..1 | string | Business agreement |
|
Σ | 1..1 | Coding |
Patient
relationship
to
subscriber
|
|
Σ | 0..* | string | Pre-Authorization/Determination Reference |
|
Σ | 0..1 | Reference ( ClaimResponse ) | Adjudication results |
|
Σ | 0..1 | Coding |
Original
version
Ruleset Codes ( Example ) |
|
Σ | 0..* | Coding |
Eligibility
exceptions
Exception Codes ( Example ) |
|
Σ | 0..1 | string | Name of School |
|
Σ | 0..1 | date | Accident Date |
|
Σ | 0..1 | Coding |
Accident
Type
|
|
Σ | 0..* | Coding |
Intervention
and
exception
code
(Pharma)
Intervention Codes ( Example ) |
|
Σ | 0..* |
|
Goods and Services |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Group
or
type
of
product
or
service
|
|
Σ | 0..1 | Reference ( Practitioner ) | Responsible practitioner |
|
Σ | 0..* |
|
Diagnosis Link |
|
Σ | 1..1 | Coding |
Item
Code
|
|
Σ | 0..1 | date | Date of Service |
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Total item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..1 | Coding |
Service
Location
|
|
Σ | 0..* | Coding |
Service
Sub-location
Surface Codes ( Example ) |
|
Σ | 0..* | Coding |
Service/Product
billing
modifiers
|
|
Σ | 0..* |
|
Additional items |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Group
or
type
of
product
or
service
|
|
Σ | 1..1 | Coding |
Additional
item
codes
|
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Total additional item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..* |
|
Additional items |
|
Σ | 1..1 |
|
Service instance |
|
Σ | 1..1 | Coding |
Type
of
product
or
service
|
|
Σ | 1..1 | Coding |
Additional
item
codes
|
|
Σ | 0..1 |
|
Count of Products or Services |
|
Σ | 0..1 | Money | Fee, charge or cost per point |
|
Σ | 0..1 | decimal | Price scaling factor |
|
Σ | 0..1 | decimal | Difficulty scaling factor |
|
Σ | 0..1 | Money | Net additional item cost |
|
Σ | 0..1 | Coding |
Unique
Device
Identifier
UDI Codes ( Example ) |
|
Σ | 0..1 |
|
Prosthetic details |
|
Σ | 0..1 | boolean | Is this the initial service |
|
Σ | 0..1 | date | Initial service Date |
|
Σ | 0..1 | Coding |
Prosthetic
Material
|
|
Σ | 0..* | Coding |
Additional
materials,
documents,
etc.
|
|
Σ | 0..* |
|
Only if type = oral |
|
Σ | 1..1 | Coding |
Tooth
Code
|
|
Σ | 0..1 | Coding |
Reason
for
missing
|
|
Σ | 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 -->
< <</identifier><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>< <</target> <</provider> <</organization> < <</priority><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> <</facility> < Prescription</prescription> < Original Prescription</originalPrescription><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> <</organization> <</person><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><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><patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan -->< < <</coverage> <<sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 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>< <</claimResponse><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> < < <</accidentType><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 -->< <</type> <</provider> <<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>< <</quantity> <</unitPrice> < < <</net><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> <</subSite> <</modifier><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 -->< <</type><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> <</unitPrice> < < <</net><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 -->< <</type> <</service> <</quantity> <</unitPrice> < < <</net><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
"
"
"
Prescription
"
Original Prescription
"
"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! 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
|
Required |
|
|
Claim.ruleset
Claim.originalRuleset Claim.coverage.originalRuleset |
The
static
and
dynamic
model
to
which
contents
conform,
which
may
be
business
version
or
|
Example |
|
| Claim.use |
Complete,
proposed,
exploratory,
|
Required |
|
| Claim.priority |
The
timeliness
with
which
processing
is
required:
STAT,
|
Example |
|
| Claim.fundsReserve |
For
whom
funds
are
to
be
reserved:
(Patient,
Provider,
|
Example |
|
| Claim.payee.type | A code for the party to be reimbursed. | Example |
|
| Claim.diagnosis.diagnosis |
ICD10
|
Example |
|
| Claim.condition |
Patient
conditions
and
|
Example |
|
| Claim.coverage.relationship |
The
code
for
the
relationship
of
the
patient
to
the
|
Example |
|
| Claim.exception | The eligibility exception codes. | Example |
|
| Claim.accidentType | Type of accident: work place, auto, etc. |
|
|
| Claim.interventionException |
Intervention
and
exception
codes
|
Example |
|
|
Claim.item.type
Claim.item.detail.type Claim.item.detail.subDetail.type |
Service, Product, Rx Dispense, Rx Compound etc. |
|
|
|
Claim.item.service
Claim.item.detail.service Claim.item.detail.subDetail.service |
Allowable
service
and
product
|
Example |
|
|
Claim.item.udi
Claim.item.detail.udi Claim.item.detail.subDetail.udi |
The FDA, or other, UDI repository. | Example |
|
| Claim.item.bodySite |
The
code
for
the
teeth,
quadrant,
sextant
and
|
Example |
|
| Claim.item.subSite |
The
code
for
the
tooth
surface
and
surface
|
Example |
|
| Claim.item.modifier |
Item
type
or
modifiers
codes,
|
Example |
|
| Claim.item.prosthesis.priorMaterial | Material of the prior denture or bridge prosthesis. (Oral) | Example |
|
| Claim.additionalMaterials | Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission. | Example |
|
| Claim.missingTeeth.tooth |
The
codes
for
the
teeth,
subset
of
|
Example |
|
| Claim.missingTeeth.reason |
Reason
codes
for
the
missing
|
Example |
|
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 |