This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.3.0:
R4
Ballot
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 : 2 | Trial Use | Compartments : Encounter , Patient , Practitioner , RelatedPerson |
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
Claim
is
used
by
providers
and
payors,
insurers,
to
exchange
the
financial
information,
and
supporting
clinical
information,
regarding
the
provision
of
healthcare
health
care
services
with
payors
an
and
firms
which
provide
data
analytics.
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
resource
may
be
interpreted
differently
depending
on
its
intended
use
(and
the
Claim.use
element
contains
the
code
to
support:
indicate):
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
http://wiki.hl7.org/index.php?title=Financial_Management_FHIR_Resource_Development
.
Mappings
to
other
specifications
may
be
made
available
where
IP
restrictions
permit.
This resource is referenced by ClaimResponse , DeviceUseStatement and ExplanationOfBenefit
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Claim,
Pre-determination
or
Pre-authorization
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Claim
number
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
0..1 | CodeableConcept |
Type
or
discipline
|
|
|
0..* | CodeableConcept |
Finer
grained
claim
type
information
Example Claim SubType Codes ( Example ) |
|
|
0..1 | code |
complete
|
proposed
|
exploratory
|
other
Use ( Required ) |
|
|
0..1 | Reference ( Patient ) | The subject of the Products and Services | |
|
0..1 | Period | Period for charge submission | |
|
0..1 | dateTime | Creation date | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Author | |
|
0..1 | Reference ( Organization ) | Target | |
|
0..1 |
Reference
(
Practitioner
|
Responsible
|
|
|
0..1 | CodeableConcept |
Desired
processing
priority
Process Priority Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Funds
requested
to
be
reserved
Funds Reservation Codes ( Example ) |
|
|
0..* | BackboneElement |
Related
Claims
which
may
be
revelant
to
processing
this
claimn
|
|
|
0..1 | Reference ( Claim ) | Reference to the related claim | |
|
0..1 | CodeableConcept |
How
the
reference
claim
is
related
Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier | Related file or case reference | |
|
0..1 | Reference ( MedicationRequest | VisionPrescription ) | Prescription authorizing services or products | |
|
0..1 | Reference ( MedicationRequest ) | Original prescription if superceded by fulfiller | |
|
0..1 | BackboneElement | Party to be paid any benefits payable | |
|
1..1 | CodeableConcept |
Type
of
party:
Subscriber,
Provider,
other
Claim Payee Type Codes ( Example ) |
|
|
0..1 | Coding |
organization
|
patient
|
practitioner
|
relatedperson
ClaimPayeeResourceType ( |
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) | Party to receive the payable | |
|
0..1 |
Reference
(
|
Treatment Referral | |
|
0..1 | Reference ( Location ) | Servicing Facility | |
|
0..* | BackboneElement |
Members
of
the
care
team
|
|
|
1..1 | positiveInt |
Number
to
|
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization ) | Provider individual or organization | |
|
0..1 | boolean | Billing provider | |
|
0..1 | CodeableConcept |
Role
on
the
team
Claim Care Team Role Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type,
classification
or
Specialization
Example Provider Qualification Codes ( Example ) |
|
|
0..* | BackboneElement |
Exceptions,
special
considerations,
the
condition,
situation,
prior
or
concurrent
issues
|
|
|
1..1 | positiveInt | Information instance identifier | |
|
1..1 | CodeableConcept |
General
class
of
information
Claim Information Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
information
Exception Codes ( Example ) |
|
|
0..1 | When it occurred | ||
|
date | |||
|
Period | |||
|
0..1 | Additional Data or supporting information | ||
| boolean | |||
![]() ![]() ![]() ![]() |
string | |||
|
Quantity | |||
|
Attachment | |||
|
Reference ( Any ) | |||
|
0..1 | CodeableConcept |
Reason
associated
with
the
information
Missing Tooth Reason Codes ( Example ) |
|
|
0..* | BackboneElement |
List
of
Diagnosis
|
|
|
1..1 | positiveInt |
Number
to
|
|
|
1..1 |
Patient's
diagnosis
ICD-10 Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | CodeableConcept |
Timing
or
nature
of
the
diagnosis
Example Diagnosis Type Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Package
billing
code
Example Diagnosis Related Group Codes ( Example ) |
|
|
0..* | BackboneElement |
Procedures
performed
|
|
|
1..1 | positiveInt | Procedure sequence for reference | |
|
0..1 | dateTime | When the procedure was performed | |
|
1..1 |
Patient's
list
of
procedures
performed
ICD-10 Procedure Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Procedure ) | |||
|
0..* | BackboneElement |
Insurance
or
medical
plan
|
|
|
1..1 | positiveInt | Service instance identifier | |
|
1..1 | boolean | Is the focal Coverage | |
| 0..1 | Identifier | Claim number | |
![]() ![]()
|
1..1 | Reference ( Coverage ) | Insurance information | |
|
0..1 | string | Business agreement | |
|
0..* | string |
Pre-Authorization/Determination
Reference
|
|
|
0..1 | Reference ( ClaimResponse ) | Adjudication results | |
|
0..1 | BackboneElement | Details about an accident | |
|
1..1 | date | When the accident occurred see information codes see information codes | |
|
0..1 | CodeableConcept |
The
nature
of
the
accident
ActIncidentCode ( |
|
|
0..1 | Accident Place | ||
|
Address | |||
|
|
|
|
|
|
0..* | BackboneElement |
Goods
and
Services
|
|
|
1..1 | positiveInt | Service instance | |
|
0..* | positiveInt |
Applicable
careTeam
members
|
|
|
0..* | positiveInt |
Applicable
diagnoses
|
|
|
0..* | positiveInt |
Applicable
procedures
|
|
|
0..* | positiveInt |
Applicable
exception
and
supporting
information
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | Date or dates of Service | ||
|
date | |||
|
Period | |||
|
0..1 |
Place
of
service
Example Service Place Codes ( Example ) |
||
|
CodeableConcept | |||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Total item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..1 | CodeableConcept |
Service
Location
Oral Site Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service
Sub-location
Surface Codes ( Example ) |
|
|
0..* | Reference ( Encounter ) |
Encounters
related
to
this
billed
item
|
|
|
0..* | BackboneElement |
Additional
items
|
|
|
1..1 | positiveInt | Service instance | |
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Total additional item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..* | BackboneElement |
Additional
items
|
|
|
1..1 | positiveInt | Service instance | |
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Net additional item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..1 | Money | Total claim cost | |
Documentation
for
this
format
|
||||
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 Claim number --></identifier>
<<status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type or discipline --></type> <subType><!-- 0..* CodeableConcept Finer grained claim type information --></subType><<use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <patient><!-- 0..1 Reference(Patient) The subject of the Products and Services --></patient> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod>< <</enterer><created value="[dateTime]"/><!-- 0..1 Creation date --> <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) Author --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer><</provider> <</organization><provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible provider --></provider> <priority><!-- 0..1 CodeableConcept Desired processing priority --></priority> <fundsReserve><!-- 0..1 CodeableConcept Funds requested to be reserved --></fundsReserve> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <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 Related file or case reference --></reference> </related> <prescription><!-- 0..1 Reference(MedicationRequest|VisionPrescription) Prescription authorizing services or products --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 1..1 CodeableConcept Type of party: Subscriber, Provider, other --></type><</resourceType> <</party><resource><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resource> <party><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) Party to receive the payable --></party> </payee><</referral><referral><!-- 0..1 Reference(ServiceRequest) Treatment Referral --></referral> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <careTeam> <!-- 0..* Members of the care team -->< <</provider> <<sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of careTeam --> <provider><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization) Provider individual or organization --></provider> <responsible value="[boolean]"/><!-- 0..1 Billing provider --> <role><!-- 0..1 CodeableConcept Role on the team --></role> <qualification><!-- 0..1 CodeableConcept Type, classification or Specialization --></qualification> </careTeam> <information> <!-- 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues --><<sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept General class of information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]><</value[x]><value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any) Additional Data or supporting information --></value[x]> <reason><!-- 0..1 CodeableConcept Reason associated with the information --></reason> </information> <diagnosis> <!-- 0..* List of Diagnosis --><<sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of diagnosis --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Patient's diagnosis --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <packageCode><!-- 0..1 CodeableConcept Package billing code --></packageCode> </diagnosis> <procedure> <!-- 0..* Procedures performed -->< <<sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <insurance> <!-- 0..* Insurance or medical plan -->< <<sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <identifier><!-- 0..1 Identifier Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage>< <<businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details about an accident --><When the accident occurred<date value="[date]"/><!-- 1..1 When the accident occurred see information codes see information codes --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident><</employmentImpacted> <</hospitalization><item> <!-- 0..* Goods and Services -->< < < < <<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <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 Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi><</bodySite><bodySite><!-- 0..1 CodeableConcept Service Location --></bodySite> <subSite><!-- 0..* CodeableConcept Service Sub-location --></subSite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <detail> <!-- 0..* Additional items --><<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --><<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Net additional 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" : "",
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Claim number
"status" : "<code>", // active | cancelled | draft | entered-in-error
"type" : { CodeableConcept }, // Type or discipline
"subType" : [{ CodeableConcept }], // Finer grained claim type information
"use" : "<code>", // complete | proposed | exploratory | other
"patient" : { Reference(Patient) }, // The subject of the Products and Services
"billablePeriod" : { Period }, // Period for charge submission
"created" : "<dateTime>", // Creation date
"enterer" : { Reference(Practitioner|PractitionerRole) }, // Author
"insurer" : { Reference(Organization) }, // Target
"provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible provider
"priority" : { CodeableConcept }, // Desired processing priority
"fundsReserve" : { CodeableConcept }, // Funds requested to be reserved
"related" : [{ // Related Claims which may be revelant to processing this claimn
"claim" : { Reference(Claim) }, // Reference to the related claim
"relationship" : { CodeableConcept }, // How the reference claim is related
"reference" : { Identifier } // Related file or case reference
}],
"
"
"
"
"
"
"prescription" : { Reference(MedicationRequest|VisionPrescription) }, // Prescription authorizing services or products
"originalPrescription" : { Reference(MedicationRequest) }, // Original prescription if superceded by fulfiller
"payee" : { // Party to be paid any benefits payable
"type" : { CodeableConcept }, // R! Type of party: Subscriber, Provider, other
"resource" : { Coding }, // organization | patient | practitioner | relatedperson
"party" : { Reference(Practitioner|PractitionerRole|Organization|Patient|
RelatedPerson) } // Party to receive the payable
},
"
"
"
"
"
"
"
"
"referral" : { Reference(ServiceRequest) }, // Treatment Referral
"facility" : { Reference(Location) }, // Servicing Facility
"careTeam" : [{ // Members of the care team
"sequence" : "<positiveInt>", // R! Number to convey order of careTeam
"provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // R! Provider individual or organization
"responsible" : <boolean>, // Billing provider
"role" : { CodeableConcept }, // Role on the team
"qualification" : { CodeableConcept } // Type, classification or Specialization
}],
"
"
"
"
"information" : [{ // Exceptions, special considerations, the condition, situation, prior or concurrent issues
"sequence" : "<positiveInt>", // R! Information instance identifier
"category" : { CodeableConcept }, // R! General class of information
"code" : { CodeableConcept }, // Type of information
// timing[x]: When it occurred. One of these 2:
">",
" },
">",
" },
" },
" },
"
"timingDate" : "<date>",
"timingPeriod" : { Period },
// value[x]: Additional Data or supporting information. One of these 5:
"valueBoolean" : <boolean>,
"valueString" : "<string>",
"valueQuantity" : { Quantity },
"valueAttachment" : { Attachment },
"valueReference" : { Reference(Any) },
"reason" : { CodeableConcept } // Reason associated with the information
}],
"
"
"diagnosis" : [{ // List of Diagnosis
"sequence" : "<positiveInt>", // R! Number to convey order of diagnosis
// diagnosis[x]: Patient's diagnosis. One of these 2:
" },
" },
"
"
"diagnosisCodeableConcept" : { CodeableConcept },
"diagnosisReference" : { Reference(Condition) },
"type" : [{ CodeableConcept }], // Timing or nature of the diagnosis
"packageCode" : { CodeableConcept } // Package billing code
}],
"
"
"
"procedure" : [{ // Procedures performed
"sequence" : "<positiveInt>", // R! Procedure sequence for reference
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Patient's list of procedures performed. One of these 2:
" }
" }
"procedureCodeableConcept" : { CodeableConcept }
"procedureReference" : { Reference(Procedure) }
}],
"
"
"
"
"
"
"
"insurance" : [{ // Insurance or medical plan
"sequence" : "<positiveInt>", // R! Service instance identifier
"focal" : <boolean>, // R! Is the focal Coverage
"identifier" : { Identifier }, // Claim number
"coverage" : { Reference(Coverage) }, // R! Insurance information
"businessArrangement" : "<string>", // Business agreement
"preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
"claimResponse" : { Reference(ClaimResponse) } // Adjudication results
}],
"
"When the accident occurred
"accident" : { // Details about an accident
"date" : "<date>", // R! When the accident occurred
see information codes
see information codes
"
"type" : { CodeableConcept }, // The nature of the accident
// location[x]: Accident Place. One of these 2:
" }
" }
"locationAddress" : { Address }
"locationReference" : { Reference(Location) }
},
"
"
"
"
"
"
"
"
"
"
"
"
"
"item" : [{ // Goods and Services
"sequence" : "<positiveInt>", // R! Service instance
"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 }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
// serviced[x]: Date or dates of Service. One of these 2:
">",
" },
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
// location[x]: Place of service. One of these 3:
" },
" },
" },
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"locationCodeableConcept" : { CodeableConcept },
"locationAddress" : { Address },
"locationReference" : { Reference(Location) },
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"bodySite" : { CodeableConcept }, // Service Location
"subSite" : [{ CodeableConcept }], // Service Sub-location
"encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item
"detail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Total additional item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"subDetail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Net additional 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..* Claim number fhir:Claim.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ CodeableConcept ]; # 0..1 Type or discipline fhir:Claim.subType [ CodeableConcept ], ... ; # 0..* Finer grained claim type information fhir:Claim.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:Claim.patient [ Reference(Patient) ]; # 0..1 The subject of the Products and Services fhir:Claim.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:Claim.created [ dateTime ]; # 0..1 Creation date
fhir:fhir:Claim.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Author fhir:Claim.insurer [ Reference(Organization) ]; # 0..1 Targetfhir: fhir:fhir:Claim.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible provider fhir:Claim.priority [ CodeableConcept ]; # 0..1 Desired processing priority fhir:Claim.fundsReserve [ CodeableConcept ]; # 0..1 Funds requested to be reserved fhir:Claim.related [ # 0..* Related Claims which may be revelant to processing this claimn 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 Related file or case reference ], ...; fhir:Claim.prescription [ Reference(MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services or products fhir:Claim.originalPrescription [ Reference(MedicationRequest) ]; # 0..1 Original prescription if superceded by fulfiller fhir:Claim.payee [ # 0..1 Party to be paid any benefits payable fhir:Claim.payee.type [ CodeableConcept ]; # 1..1 Type of party: Subscriber, Provider, otherfhir: fhir:fhir:Claim.payee.resource [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson fhir:Claim.payee.party [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson) ]; # 0..1 Party to receive the payable ];fhir:fhir:Claim.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment Referral fhir:Claim.facility [ Reference(Location) ]; # 0..1 Servicing Facility fhir:Claim.careTeam [ # 0..* Members of the care teamfhir: fhir:fhir:Claim.careTeam.sequence [ positiveInt ]; # 1..1 Number to convey order of careTeam fhir:Claim.careTeam.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 1..1 Provider individual or organization fhir:Claim.careTeam.responsible [ boolean ]; # 0..1 Billing provider fhir:Claim.careTeam.role [ CodeableConcept ]; # 0..1 Role on the team fhir:Claim.careTeam.qualification [ CodeableConcept ]; # 0..1 Type, classification or Specialization ], ...; fhir:Claim.information [ # 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues fhir:Claim.information.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:Claim.information.category [ CodeableConcept ]; # 1..1 General class of information fhir:Claim.information.code [ CodeableConcept ]; # 0..1 Type of information # Claim.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.information.timingDate [ date ] fhir:Claim.information.timingPeriod [ Period ]# . One of these 4# Claim.information.value[x] : 0..1 Additional Data or supporting information. One of these 5 fhir:Claim.information.valueBoolean [ boolean ] fhir:Claim.information.valueString [ string ] fhir:Claim.information.valueQuantity [ Quantity ] fhir:Claim.information.valueAttachment [ Attachment ] fhir:Claim.information.valueReference [ Reference(Any) ] fhir:Claim.information.reason [ CodeableConcept ]; # 0..1 Reason associated with the information ], ...; fhir:Claim.diagnosis [ # 0..* List of Diagnosisfhir:fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Number to convey order of diagnosis # Claim.diagnosis.diagnosis[x] : 1..1 Patient's diagnosis. 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.packageCode [ CodeableConcept ]; # 0..1 Package billing code ], ...; fhir:Claim.procedure [ # 0..* Procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:Claim.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] ], ...; fhir:Claim.insurance [ # 0..* Insurance or medical plan fhir:Claim.insurance.sequence [ positiveInt ]; # 1..1 Service instance identifier fhir:Claim.insurance.focal [ boolean ]; # 1..1 Is the focal Coverage fhir:Claim.insurance.identifier [ Identifier ]; # 0..1 Claim number fhir:Claim.insurance.coverage [ Reference(Coverage) ]; # 1..1 Insurance information fhir:Claim.insurance.businessArrangement [ string ]; # 0..1 Business agreement fhir:Claim.insurance.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference fhir:Claim.insurance.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results ], ...; fhir:Claim.accident [ # 0..1 Details about an accident fhir:Claim.accident.date [ date ]; # 1..1 When the accident occurred see information codes see information codes fhir:Claim.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ];fhir: fhir:fhir:Claim.item [ # 0..* Goods and Services fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Service instancefhir: fhir: fhir: fhir: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 Type of service or product fhir:Claim.item.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion # Claim.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service. One of these 3 fhir:Claim.item.locationCodeableConcept [ CodeableConcept ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] 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 point fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifierfhir:fhir:Claim.item.bodySite [ CodeableConcept ]; # 0..1 Service Location fhir:Claim.item.subSite [ CodeableConcept ], ... ; # 0..* Service Sub-location fhir:Claim.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.item.detail [ # 0..* Additional items fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:Claim.item.detail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion 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 point fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.detail.subDetail [ # 0..* Additional items fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:Claim.item.detail.subDetail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion 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 point fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Net additional 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
DSTU2
R3
| Claim |
|
| Claim.type |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Claim.diagnosis.diagnosis[x] |
|
| Claim.procedure.procedure[x] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Claim,
Pre-determination
or
Pre-authorization
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Claim
number
|
|
|
?! Σ | 0..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Financial Resource Status Codes ( Required ) |
|
0..1 | CodeableConcept |
Type
or
discipline
|
|
|
0..* | CodeableConcept |
Finer
grained
claim
type
information
Example Claim SubType Codes ( Example ) |
|
|
0..1 | code |
complete
|
proposed
|
exploratory
|
other
Use ( Required ) |
|
|
0..1 | Reference ( Patient ) | The subject of the Products and Services | |
|
0..1 | Period | Period for charge submission | |
|
0..1 | dateTime | Creation date | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Author | |
|
0..1 | Reference ( Organization ) | Target | |
|
0..1 |
Reference
(
Practitioner
|
Responsible
|
|
|
0..1 | CodeableConcept |
Desired
processing
priority
Process Priority Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Funds
requested
to
be
reserved
Funds Reservation Codes ( Example ) |
|
|
0..* | BackboneElement |
Related
Claims
which
may
be
revelant
to
processing
this
claimn
|
|
|
0..1 | Reference ( Claim ) | Reference to the related claim | |
|
0..1 | CodeableConcept |
How
the
reference
claim
is
related
Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier | Related file or case reference | |
|
0..1 | Reference ( MedicationRequest | VisionPrescription ) | Prescription authorizing services or products | |
|
0..1 | Reference ( MedicationRequest ) | Original prescription if superceded by fulfiller | |
|
0..1 | BackboneElement | Party to be paid any benefits payable | |
|
1..1 | CodeableConcept |
Type
of
party:
Subscriber,
Provider,
other
Claim Payee Type Codes ( Example ) |
|
|
0..1 | Coding |
organization
|
patient
|
practitioner
|
relatedperson
ClaimPayeeResourceType ( |
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) | Party to receive the payable | |
|
0..1 |
Reference
(
|
Treatment Referral | |
|
0..1 | Reference ( Location ) | Servicing Facility | |
|
0..* | BackboneElement |
Members
of
the
care
team
|
|
|
1..1 | positiveInt |
Number
to
|
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization ) | Provider individual or organization | |
|
0..1 | boolean | Billing provider | |
|
0..1 | CodeableConcept |
Role
on
the
team
Claim Care Team Role Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type,
classification
or
Specialization
Example Provider Qualification Codes ( Example ) |
|
|
0..* | BackboneElement |
Exceptions,
special
considerations,
the
condition,
situation,
prior
or
concurrent
issues
|
|
|
1..1 | positiveInt | Information instance identifier | |
|
1..1 | CodeableConcept |
General
class
of
information
Claim Information Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
information
Exception Codes ( Example ) |
|
|
0..1 | When it occurred | ||
|
date | |||
|
Period | |||
|
0..1 | Additional Data or supporting information | ||
| boolean | |||
![]() ![]() ![]() ![]() |
string | |||
|
Quantity | |||
|
Attachment | |||
|
Reference ( Any ) | |||
|
0..1 | CodeableConcept |
Reason
associated
with
the
information
Missing Tooth Reason Codes ( Example ) |
|
|
0..* | BackboneElement |
List
of
Diagnosis
|
|
|
1..1 | positiveInt |
Number
to
|
|
|
1..1 |
Patient's
diagnosis
ICD-10 Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | CodeableConcept |
Timing
or
nature
of
the
diagnosis
Example Diagnosis Type Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Package
billing
code
Example Diagnosis Related Group Codes ( Example ) |
|
|
0..* | BackboneElement |
Procedures
performed
|
|
|
1..1 | positiveInt | Procedure sequence for reference | |
|
0..1 | dateTime | When the procedure was performed | |
|
1..1 |
Patient's
list
of
procedures
performed
ICD-10 Procedure Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Procedure ) | |||
|
0..* | BackboneElement |
Insurance
or
medical
plan
|
|
|
1..1 | positiveInt | Service instance identifier | |
|
1..1 | boolean | Is the focal Coverage | |
| 0..1 | Identifier | Claim number | |
![]() ![]()
|
1..1 | Reference ( Coverage ) | Insurance information | |
|
0..1 | string | Business agreement | |
|
0..* | string |
Pre-Authorization/Determination
Reference
|
|
|
0..1 | Reference ( ClaimResponse ) | Adjudication results | |
|
0..1 | BackboneElement | Details about an accident | |
|
1..1 | date | When the accident occurred see information codes see information codes | |
|
0..1 | CodeableConcept |
The
nature
of
the
accident
ActIncidentCode ( |
|
|
0..1 | Accident Place | ||
|
Address | |||
|
|
|
|
|
|
0..* | BackboneElement |
Goods
and
Services
|
|
|
1..1 | positiveInt | Service instance | |
|
0..* | positiveInt |
Applicable
careTeam
members
|
|
|
0..* | positiveInt |
Applicable
diagnoses
|
|
|
0..* | positiveInt |
Applicable
procedures
|
|
|
0..* | positiveInt |
Applicable
exception
and
supporting
information
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | Date or dates of Service | ||
|
date | |||
|
Period | |||
|
0..1 |
Place
of
service
Example Service Place Codes ( Example ) |
||
|
CodeableConcept | |||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Total item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..1 | CodeableConcept |
Service
Location
Oral Site Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service
Sub-location
Surface Codes ( Example ) |
|
|
0..* | Reference ( Encounter ) |
Encounters
related
to
this
billed
item
|
|
|
0..* | BackboneElement |
Additional
items
|
|
|
1..1 | positiveInt | Service instance | |
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Total additional item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..* | BackboneElement |
Additional
items
|
|
|
1..1 | positiveInt | Service instance | |
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Type
of
service
or
product
Benefit SubCategory Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing
Code
USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
specific
reason
for
item
inclusion
Example Program Reason Codes ( Example ) |
|
|
0..1 | SimpleQuantity | Count of Products or Services | |
|
0..1 | Money | Fee, charge or cost per point | |
|
0..1 | decimal | Price scaling factor | |
|
0..1 | Money | Net additional item cost | |
|
0..* | Reference ( Device ) |
Unique
Device
Identifier
|
|
|
0..1 | Money | Total claim cost | |
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><!-- 0..* Identifier Claim number --></identifier>
<<status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error --> <type><!-- 0..1 CodeableConcept Type or discipline --></type> <subType><!-- 0..* CodeableConcept Finer grained claim type information --></subType><<use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <patient><!-- 0..1 Reference(Patient) The subject of the Products and Services --></patient> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod>< <</enterer><created value="[dateTime]"/><!-- 0..1 Creation date --> <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) Author --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer><</provider> <</organization><provider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible provider --></provider> <priority><!-- 0..1 CodeableConcept Desired processing priority --></priority> <fundsReserve><!-- 0..1 CodeableConcept Funds requested to be reserved --></fundsReserve> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <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 Related file or case reference --></reference> </related> <prescription><!-- 0..1 Reference(MedicationRequest|VisionPrescription) Prescription authorizing services or products --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 1..1 CodeableConcept Type of party: Subscriber, Provider, other --></type><</resourceType> <</party><resource><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resource> <party><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization|Patient| RelatedPerson) Party to receive the payable --></party> </payee><</referral><referral><!-- 0..1 Reference(ServiceRequest) Treatment Referral --></referral> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <careTeam> <!-- 0..* Members of the care team -->< <</provider> <<sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of careTeam --> <provider><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization) Provider individual or organization --></provider> <responsible value="[boolean]"/><!-- 0..1 Billing provider --> <role><!-- 0..1 CodeableConcept Role on the team --></role> <qualification><!-- 0..1 CodeableConcept Type, classification or Specialization --></qualification> </careTeam> <information> <!-- 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues --><<sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept General class of information --></category> <code><!-- 0..1 CodeableConcept Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]><</value[x]><value[x]><!-- 0..1 boolean|string|Quantity|Attachment|Reference(Any) Additional Data or supporting information --></value[x]> <reason><!-- 0..1 CodeableConcept Reason associated with the information --></reason> </information> <diagnosis> <!-- 0..* List of Diagnosis --><<sequence value="[positiveInt]"/><!-- 1..1 Number to convey order of diagnosis --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Patient's diagnosis --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <packageCode><!-- 0..1 CodeableConcept Package billing code --></packageCode> </diagnosis> <procedure> <!-- 0..* Procedures performed -->< <<sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <insurance> <!-- 0..* Insurance or medical plan -->< <<sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <identifier><!-- 0..1 Identifier Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage>< <<businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details about an accident --><When the accident occurred<date value="[date]"/><!-- 1..1 When the accident occurred see information codes see information codes --> <type><!-- 0..1 CodeableConcept The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident><</employmentImpacted> <</hospitalization><item> <!-- 0..* Goods and Services -->< < < < <<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <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 Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi><</bodySite><bodySite><!-- 0..1 CodeableConcept Service Location --></bodySite> <subSite><!-- 0..* CodeableConcept Service Sub-location --></subSite> <encounter><!-- 0..* Reference(Encounter) Encounters related to this billed item --></encounter> <detail> <!-- 0..* Additional items --><<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --><<sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Type of service or product --></category> <service><!-- 0..1 CodeableConcept Billing Code --></service> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice><<factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <net><!-- 0..1 Money Net additional 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" : "",
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Claim number
"status" : "<code>", // active | cancelled | draft | entered-in-error
"type" : { CodeableConcept }, // Type or discipline
"subType" : [{ CodeableConcept }], // Finer grained claim type information
"use" : "<code>", // complete | proposed | exploratory | other
"patient" : { Reference(Patient) }, // The subject of the Products and Services
"billablePeriod" : { Period }, // Period for charge submission
"created" : "<dateTime>", // Creation date
"enterer" : { Reference(Practitioner|PractitionerRole) }, // Author
"insurer" : { Reference(Organization) }, // Target
"provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible provider
"priority" : { CodeableConcept }, // Desired processing priority
"fundsReserve" : { CodeableConcept }, // Funds requested to be reserved
"related" : [{ // Related Claims which may be revelant to processing this claimn
"claim" : { Reference(Claim) }, // Reference to the related claim
"relationship" : { CodeableConcept }, // How the reference claim is related
"reference" : { Identifier } // Related file or case reference
}],
"
"
"
"
"
"
"prescription" : { Reference(MedicationRequest|VisionPrescription) }, // Prescription authorizing services or products
"originalPrescription" : { Reference(MedicationRequest) }, // Original prescription if superceded by fulfiller
"payee" : { // Party to be paid any benefits payable
"type" : { CodeableConcept }, // R! Type of party: Subscriber, Provider, other
"resource" : { Coding }, // organization | patient | practitioner | relatedperson
"party" : { Reference(Practitioner|PractitionerRole|Organization|Patient|
RelatedPerson) } // Party to receive the payable
},
"
"
"
"
"
"
"
"
"referral" : { Reference(ServiceRequest) }, // Treatment Referral
"facility" : { Reference(Location) }, // Servicing Facility
"careTeam" : [{ // Members of the care team
"sequence" : "<positiveInt>", // R! Number to convey order of careTeam
"provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // R! Provider individual or organization
"responsible" : <boolean>, // Billing provider
"role" : { CodeableConcept }, // Role on the team
"qualification" : { CodeableConcept } // Type, classification or Specialization
}],
"
"
"
"
"information" : [{ // Exceptions, special considerations, the condition, situation, prior or concurrent issues
"sequence" : "<positiveInt>", // R! Information instance identifier
"category" : { CodeableConcept }, // R! General class of information
"code" : { CodeableConcept }, // Type of information
// timing[x]: When it occurred. One of these 2:
">",
" },
">",
" },
" },
" },
"
"timingDate" : "<date>",
"timingPeriod" : { Period },
// value[x]: Additional Data or supporting information. One of these 5:
"valueBoolean" : <boolean>,
"valueString" : "<string>",
"valueQuantity" : { Quantity },
"valueAttachment" : { Attachment },
"valueReference" : { Reference(Any) },
"reason" : { CodeableConcept } // Reason associated with the information
}],
"
"
"diagnosis" : [{ // List of Diagnosis
"sequence" : "<positiveInt>", // R! Number to convey order of diagnosis
// diagnosis[x]: Patient's diagnosis. One of these 2:
" },
" },
"
"
"diagnosisCodeableConcept" : { CodeableConcept },
"diagnosisReference" : { Reference(Condition) },
"type" : [{ CodeableConcept }], // Timing or nature of the diagnosis
"packageCode" : { CodeableConcept } // Package billing code
}],
"
"
"
"procedure" : [{ // Procedures performed
"sequence" : "<positiveInt>", // R! Procedure sequence for reference
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Patient's list of procedures performed. One of these 2:
" }
" }
"procedureCodeableConcept" : { CodeableConcept }
"procedureReference" : { Reference(Procedure) }
}],
"
"
"
"
"
"
"
"insurance" : [{ // Insurance or medical plan
"sequence" : "<positiveInt>", // R! Service instance identifier
"focal" : <boolean>, // R! Is the focal Coverage
"identifier" : { Identifier }, // Claim number
"coverage" : { Reference(Coverage) }, // R! Insurance information
"businessArrangement" : "<string>", // Business agreement
"preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
"claimResponse" : { Reference(ClaimResponse) } // Adjudication results
}],
"
"When the accident occurred
"accident" : { // Details about an accident
"date" : "<date>", // R! When the accident occurred
see information codes
see information codes
"
"type" : { CodeableConcept }, // The nature of the accident
// location[x]: Accident Place. One of these 2:
" }
" }
"locationAddress" : { Address }
"locationReference" : { Reference(Location) }
},
"
"
"
"
"
"
"
"
"
"
"
"
"
"item" : [{ // Goods and Services
"sequence" : "<positiveInt>", // R! Service instance
"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 }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
// serviced[x]: Date or dates of Service. One of these 2:
">",
" },
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
// location[x]: Place of service. One of these 3:
" },
" },
" },
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"locationCodeableConcept" : { CodeableConcept },
"locationAddress" : { Address },
"locationReference" : { Reference(Location) },
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"bodySite" : { CodeableConcept }, // Service Location
"subSite" : [{ CodeableConcept }], // Service Sub-location
"encounter" : [{ Reference(Encounter) }], // Encounters related to this billed item
"detail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Total additional item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"subDetail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Type of service or product
"service" : { CodeableConcept }, // Billing Code
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Money }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"net" : { Money }, // Net additional 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..* Claim number fhir:Claim.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ CodeableConcept ]; # 0..1 Type or discipline fhir:Claim.subType [ CodeableConcept ], ... ; # 0..* Finer grained claim type information fhir:Claim.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:Claim.patient [ Reference(Patient) ]; # 0..1 The subject of the Products and Services fhir:Claim.billablePeriod [ Period ]; # 0..1 Period for charge submission fhir:Claim.created [ dateTime ]; # 0..1 Creation date
fhir:fhir:Claim.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Author fhir:Claim.insurer [ Reference(Organization) ]; # 0..1 Targetfhir: fhir:fhir:Claim.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible provider fhir:Claim.priority [ CodeableConcept ]; # 0..1 Desired processing priority fhir:Claim.fundsReserve [ CodeableConcept ]; # 0..1 Funds requested to be reserved fhir:Claim.related [ # 0..* Related Claims which may be revelant to processing this claimn 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 Related file or case reference ], ...; fhir:Claim.prescription [ Reference(MedicationRequest|VisionPrescription) ]; # 0..1 Prescription authorizing services or products fhir:Claim.originalPrescription [ Reference(MedicationRequest) ]; # 0..1 Original prescription if superceded by fulfiller fhir:Claim.payee [ # 0..1 Party to be paid any benefits payable fhir:Claim.payee.type [ CodeableConcept ]; # 1..1 Type of party: Subscriber, Provider, otherfhir: fhir:fhir:Claim.payee.resource [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson fhir:Claim.payee.party [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson) ]; # 0..1 Party to receive the payable ];fhir:fhir:Claim.referral [ Reference(ServiceRequest) ]; # 0..1 Treatment Referral fhir:Claim.facility [ Reference(Location) ]; # 0..1 Servicing Facility fhir:Claim.careTeam [ # 0..* Members of the care teamfhir: fhir:fhir:Claim.careTeam.sequence [ positiveInt ]; # 1..1 Number to convey order of careTeam fhir:Claim.careTeam.provider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 1..1 Provider individual or organization fhir:Claim.careTeam.responsible [ boolean ]; # 0..1 Billing provider fhir:Claim.careTeam.role [ CodeableConcept ]; # 0..1 Role on the team fhir:Claim.careTeam.qualification [ CodeableConcept ]; # 0..1 Type, classification or Specialization ], ...; fhir:Claim.information [ # 0..* Exceptions, special considerations, the condition, situation, prior or concurrent issues fhir:Claim.information.sequence [ positiveInt ]; # 1..1 Information instance identifier fhir:Claim.information.category [ CodeableConcept ]; # 1..1 General class of information fhir:Claim.information.code [ CodeableConcept ]; # 0..1 Type of information # Claim.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.information.timingDate [ date ] fhir:Claim.information.timingPeriod [ Period ]# . One of these 4# Claim.information.value[x] : 0..1 Additional Data or supporting information. One of these 5 fhir:Claim.information.valueBoolean [ boolean ] fhir:Claim.information.valueString [ string ] fhir:Claim.information.valueQuantity [ Quantity ] fhir:Claim.information.valueAttachment [ Attachment ] fhir:Claim.information.valueReference [ Reference(Any) ] fhir:Claim.information.reason [ CodeableConcept ]; # 0..1 Reason associated with the information ], ...; fhir:Claim.diagnosis [ # 0..* List of Diagnosisfhir:fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Number to convey order of diagnosis # Claim.diagnosis.diagnosis[x] : 1..1 Patient's diagnosis. 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.packageCode [ CodeableConcept ]; # 0..1 Package billing code ], ...; fhir:Claim.procedure [ # 0..* Procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:Claim.procedure.procedureCodeableConcept [ CodeableConcept ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] ], ...; fhir:Claim.insurance [ # 0..* Insurance or medical plan fhir:Claim.insurance.sequence [ positiveInt ]; # 1..1 Service instance identifier fhir:Claim.insurance.focal [ boolean ]; # 1..1 Is the focal Coverage fhir:Claim.insurance.identifier [ Identifier ]; # 0..1 Claim number fhir:Claim.insurance.coverage [ Reference(Coverage) ]; # 1..1 Insurance information fhir:Claim.insurance.businessArrangement [ string ]; # 0..1 Business agreement fhir:Claim.insurance.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference fhir:Claim.insurance.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results ], ...; fhir:Claim.accident [ # 0..1 Details about an accident fhir:Claim.accident.date [ date ]; # 1..1 When the accident occurred see information codes see information codes fhir:Claim.accident.type [ CodeableConcept ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ];fhir: fhir:fhir:Claim.item [ # 0..* Goods and Services fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Service instancefhir: fhir: fhir: fhir: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 Type of service or product fhir:Claim.item.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion # Claim.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service. One of these 3 fhir:Claim.item.locationCodeableConcept [ CodeableConcept ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] 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 point fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifierfhir:fhir:Claim.item.bodySite [ CodeableConcept ]; # 0..1 Service Location fhir:Claim.item.subSite [ CodeableConcept ], ... ; # 0..* Service Sub-location fhir:Claim.item.encounter [ Reference(Encounter) ], ... ; # 0..* Encounters related to this billed item fhir:Claim.item.detail [ # 0..* Additional items fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:Claim.item.detail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.detail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion 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 point fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.detail.subDetail [ # 0..* Additional items fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.subDetail.revenue [ CodeableConcept ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ CodeableConcept ]; # 0..1 Type of service or product fhir:Claim.item.detail.subDetail.service [ CodeableConcept ]; # 0..1 Billing Code fhir:Claim.item.detail.subDetail.modifier [ CodeableConcept ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ CodeableConcept ], ... ; # 0..* Program specific reason for item inclusion 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 point fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Net additional 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 DSTU2
| Claim |
|
| Claim.type |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Claim.diagnosis.diagnosis[x] |
|
| Claim.procedure.procedure[x] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
Alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Claim.status | A code specifying the state of the resource instance. | Required | Financial Resource Status Codes |
| Claim.type | The type or discipline-style of the claim |
|
|
| Claim.subType | A more granular claim typecode | Example | Example Claim SubType Codes |
| Claim.use | Complete, proposed, exploratory, other | Required | Use |
| Claim.priority | The timeliness with which processing is required: STAT, normal, Deferred | Example | Process Priority Codes |
| Claim.fundsReserve | For whom funds are to be reserved: (Patient, Provider, None). | Example | Funds Reservation Codes |
| Claim.related.relationship | Relationship of this claim to a related Claim | Example | Example Related Claim Relationship Codes |
| Claim.payee.type | A code for the party to be reimbursed. | Example | Claim Payee Type Codes |
|
|
The type of Claim payee Resource |
|
ClaimPayeeResourceType |
| Claim.careTeam.role | The role codes for the care team members. | Example | Claim Care Team Role Codes |
| Claim.careTeam.qualification | Provider professional qualifications | Example | Example Provider Qualification Codes |
| Claim.information.category | The valuset used for additional information category codes. | Example | Claim Information Category Codes |
| Claim.information.code | The valuset used for additional information codes. | Example | Exception Codes |
| Claim.information.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
| Claim.diagnosis.diagnosis[x] | ICD10 Diagnostic codes | Example | ICD-10 Codes |
| Claim.diagnosis.type | The type of the diagnosis: admitting, principal, discharge | Example | Example Diagnosis Type Codes |
| Claim.diagnosis.packageCode | The DRG codes associated with the diagnosis | Example | Example Diagnosis Related Group Codes |
| Claim.procedure.procedure[x] | ICD10 Procedure codes | Example | ICD-10 Procedure Codes |
| Claim.accident.type | Type of accident: work place, auto, etc. |
|
ActIncidentCode |
|
Claim.item.revenue
Claim.item.detail.revenue Claim.item.detail.subDetail.revenue |
Codes for the revenue or cost centers supplying the service and/or products. | Example | Example Revenue Center Codes |
|
Claim.item.category
Claim.item.detail.category Claim.item.detail.subDetail.category |
Benefit subcategories such as: oral-basic, major, glasses | Example | Benefit SubCategory Codes |
|
Claim.item.service
Claim.item.detail.service Claim.item.detail.subDetail.service |
Allowable service and product codes | Example | USCLS Codes |
|
Claim.item.modifier
Claim.item.detail.modifier Claim.item.detail.subDetail.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.programCode
Claim.item.detail.programCode Claim.item.detail.subDetail.programCode |
Program specific reason codes | Example | Example Program Reason Codes |
| Claim.item.location[x] | Place of service: pharmacy,school, prison, etc. | Example | Example Service Place Codes |
| Claim.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example | Oral Site Codes |
| Claim.item.subSite | The code for the tooth surface and surface combinations | Example | Surface 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 | Expression | In Common |
| care-team | reference | Member of the CareTeam |
Claim.careTeam.provider
( Practitioner , Organization , PractitionerRole ) |
|
| created | date | The creation date for the Claim | Claim.created | |
| 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 , PractitionerRole ) |
|
| facility | reference | Facility responsible for the goods and services |
Claim.facility
( Location ) |
|
| identifier | token | The primary identifier of the financial resource | Claim.identifier | |
| insurer | reference | The target payor/insurer for the Claim |
Claim.insurer
( Organization ) |
|
| patient | reference | Patient receiving the 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 | |
| provider | reference | Provider responsible for the Claim |
Claim.provider
( Practitioner , Organization , PractitionerRole ) |
|
| status | token | The status of the Claim instance. | Claim.status | |
| use | token | The kind of financial resource | Claim.use |