This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Financial
Management
Work
Group
|
|
Security Category : Patient | Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson |
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
The
Claim
is
used
by
providers
and
payors,
payers,
insurers,
to
exchange
the
financial
information,
and
supporting
clinical
information,
regarding
the
provision
of
health
care
services
with
payors
payers
and
for
reporting
to
regulatory
bodies
and
firms
which
provide
data
analytics.
The
primary
uses
of
this
resource
is
to
support
eClaims,
the
exchange
of
information
relating
to
the
proposed
or
actual
provision
of
healthcare-related
goods
and
services
for
patients
to
their
benefit
payors,
payers,
insurers
and
national
health
programs,
for
treatment
payment
planning
and
reimbursement.
The Claim resource is a "request" resource from a FHIR workflow perspective - see Workflow Request.
The Claim resource may be interpreted differently depending on its intended use (and the Claim.use element contains the code to indicate):
The Claim.type code system provides oral, pharmacy, vision, professional and institutional claim types. Claim types supported are influenced by the requirements of the implementing jurisdiction. The valueset is extensible to accommodate other types of claims as required by the jurisdiction.
The Claim also supports:
Mapping
to
other
Claim
specifications:
Mappings
are
currently
maintained
by
the
Financial
Management
Work
Group
to
UB04
and
CMS1500
and
are
available
at
https://confluence.hl7.org/display/FM/FHIR+Resource+Development
.
Mappings
to
other
specifications
may
be
made
available
where
IP
restrictions
permit.
Additional information regarding electronic claims content and usage may be found at:
The Claim resource is used to request the adjudication and/or authorization of a set of healthcare-related goods and services for a patient against the patient's insurance coverages, or to request what the adjudication would be for a supplied set of goods or services should they be actually supplied to the patient.
When requesting whether the patient's coverage is inforce, whether it is valid at this or a specified date, or requesting the benefit details or preauthorization requirements associated with a coverage, then CoverageEligibilityRequest should be used instead.
When using the resources for reporting and transferring claims data, which may have originated in some standard other than FHIR, the Claim resource is useful if only the request side of the information exchange is of interest. If, however, both the request and the adjudication information is to be reported then the ExplanationOfBenefit should be used instead.
For reporting out to patients or transferring data to patient centered applications, such as Personal Health Record (PHR) application, the ExplanationOfBenefit should be used instead of the Claim and ClaimResponse resources as those resources may contain provider and payer specific information which is not appropriate for sharing with the patient.
The eClaim domain includes a number of related resources
| Claim | A suite of goods and services and insurances coverages under which adjudication or authorization is requested. |
| CoverageEligibilityRequest |
A
request
to
a
|
| ClaimResponse |
A
|
| ExplanationOfBenefit |
This
resource
combines
the
information
from
the
Claim
and
the
ClaimResponse,
stripping
out
any
provider
or
|
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
TU | DomainResource |
Claim,
Pre-determination
or
Pre-authorization
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
Identifier
for
claim
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
?! Σ | 1..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Binding: Financial Resource Status Codes ( Required ) |
| Σ | 0..1 | string |
Reason
for
status
change
|
![]() ![]() |
Σ | 1..1 | CodeableConcept |
Category
or
discipline
Binding: Claim Type Codes ( Extensible ) |
|
0..1 | CodeableConcept |
More
granular
claim
type
Binding: Example Claim SubType Codes ( Example ) |
|
|
Σ | 1..1 | code |
claim
|
preauthorization
|
predetermination
Binding: Use ( Required ) |
|
Σ | 1..1 | Reference ( Patient | Group ) |
The
|
|
Σ | 0..1 | Period |
Relevant
time
frame
for
the
claim
|
|
Σ | 1..1 | dateTime |
Resource
creation
date
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson ) |
Author
of
the
claim
|
|
|
Σ | 0..1 | Reference ( Organization ) |
Target
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Party
responsible
for
the
claim
|
|
Σ | 0..1 | CodeableConcept |
Desired
processing
urgency
Binding: Process Priority Codes ( |
|
0..1 | CodeableConcept |
For
whom
to
reserve
funds
Binding: Funds Reservation Codes ( |
|
|
0..* | BackboneElement |
Prior
or
corollary
claims
|
|
|
0..1 | Reference ( Claim ) |
Reference
to
the
related
claim
|
|
|
0..1 | CodeableConcept |
How
the
reference
claim
is
related
Binding: Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier |
File
or
case
reference
|
|
|
0..1 | Reference ( DeviceRequest | MedicationRequest | ServiceRequest | VisionPrescription ) |
Prescription
authorizing
services
and
products
|
|
|
0..1 | Reference ( DeviceRequest | MedicationRequest | ServiceRequest | VisionPrescription ) |
Original
prescription
if
superseded
by
fulfiller
|
|
|
0..1 | BackboneElement |
Recipient
of
benefits
payable
|
|
|
1..1 | CodeableConcept |
Category
of
recipient
Binding: Claim Payee Type Codes ( Example ) |
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) |
Recipient
reference
|
|
|
0..1 | Reference ( ServiceRequest ) |
Treatment
referral
|
|
|
0..* | Reference ( Encounter ) |
Encounters
associated
with
the
listed
treatments
|
|
|
0..1 | Reference ( Location | Organization ) |
Servicing
facility
|
|
|
0..1 | CodeableConcept |
Package
billing
code
Binding: Example Diagnosis Related Group Codes ( Example ) |
|
|
0..* | BackboneElement |
Event
information
|
|
|
1..1 | CodeableConcept |
Specific
event
Binding: Dates Type Codes ( Example ) |
|
|
1..1 |
Occurance
date
or
period
|
||
|
dateTime | |||
|
Period | |||
|
0..* | BackboneElement |
Members
of
the
care
team
|
|
|
1..1 | positiveInt |
Order
of
care
team
|
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Practitioner
or
organization
|
|
|
0..1 | CodeableConcept |
Function
within
the
team
Binding: Claim Care Team Role Codes ( |
|
|
0..1 | CodeableConcept |
Practitioner
or
provider
specialization
Binding: Example Provider Qualification Codes ( Example ) |
|
|
0..* | BackboneElement |
Supporting
information
|
|
|
1..1 | positiveInt |
Information
instance
identifier
|
|
|
1..1 | CodeableConcept |
Classification
of
the
supplied
information
Binding: Claim Information Category Codes ( |
|
|
0..1 | CodeableConcept |
Finer-grained
classification
of
the
supplied
information
Binding: |
|
|
0..1 | CodeableConcept |
Type
of
information
|
|
|
0..1 |
When
it
occurred
|
||
|
|
|||
|
|
|||
|
|
|||
|
|
0..1 |
|
Data
to
be
provided
|
|
0..1 | CodeableConcept |
Explanation
for
the
information
Binding: Missing Tooth Reason Codes ( Example ) |
|
|
0..* | BackboneElement |
Pertinent
diagnosis
information
|
|
|
1..1 | positiveInt |
Diagnosis
instance
identifier
|
|
|
1..1 |
Nature
of
illness
or
problem
Binding: ICD-10 Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | CodeableConcept |
Timing
or
nature
of
the
diagnosis
Binding: Example Diagnosis Type Codes ( |
|
|
0..1 | CodeableConcept |
Present
on
admission
Binding: Example Diagnosis on Admission Codes ( |
|
|
0..* | BackboneElement |
Clinical
procedures
performed
|
|
|
1..1 | positiveInt |
Procedure
instance
identifier
|
|
|
0..* | CodeableConcept |
Category
of
Procedure
Binding: Example Procedure Type Codes ( |
|
|
0..1 | dateTime |
When
the
procedure
was
performed
|
|
|
1..1 |
Specific
clinical
procedure
Binding: ICD-10 Procedure Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Procedure ) | |||
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
Σ | 0..* | BackboneElement |
Patient
insurance
information
|
|
Σ | 1..1 | positiveInt |
Insurance
instance
identifier
|
|
Σ | 1..1 | boolean |
Coverage
to
be
used
for
adjudication
|
|
0..1 | Identifier |
Pre-assigned
Claim
number
|
|
|
Σ | 1..1 | Reference ( Coverage ) |
Insurance
information
|
|
0..1 | string |
Additional
provider
contract
number
|
|
|
0..* | string |
Prior
authorization
reference
number
|
|
|
0..1 | Reference ( ClaimResponse ) |
Adjudication
results
|
|
|
0..1 | BackboneElement |
Details
of
the
event
|
|
|
1..1 | date |
When
the
incident
occurred
|
|
|
0..1 | CodeableConcept |
The
nature
of
the
accident
Binding: ActIncidentCode
(
Extensible
)
|
|
|
0..1 |
Where
the
event
occurred
|
||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
| 0..1 | Reference ( Patient | Group ) |
The
recipient
of
the
products
and
services
| |
![]() ![]() ![]() |
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
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* |
Reference
(
DeviceRequest
|
MedicationRequest
|
NutritionOrder
|
ServiceRequest
|
|
Request
or
Referral
for
Service
|
|
|
0..* | CodeableConcept |
Product
or
service
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 |
Date
or
dates
of
service
or
product
delivery
|
||
|
date | |||
|
Period | |||
|
0..1 |
Place
of
service
or
where
product
was
supplied
Binding: Example Service Place Codes ( Example ) |
||
|
CodeableConcept | |||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..* | BackboneElement |
Anatomical
location
|
|
|
1..* | CodeableReference ( BodyStructure ) |
Location
Binding: Oral Site Codes ( Example ) |
|
|
0..* | CodeableConcept |
Sub-location
Binding: Surface Codes ( Example ) |
|
|
0..* | Reference ( Encounter ) |
Encounters
associated
with
the
listed
treatments
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..1 | Money |
Total
claim
cost
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<Claim xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier for claim --></identifier> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <statusReason value="[string]"/><!-- 0..1 Reason for status change --> <type><!-- 1..1 CodeableConcept Category or discipline --></type> <subType><!-- 0..1 CodeableConcept More granular claim type --></subType> <use value="[code]"/><!-- 1..1 claim | preauthorization | predetermination -->
<</patient><subject><!-- 1..1 Reference(Group|Patient) The recipient(s) of the products and services --></subject> <billablePeriod><!-- 0..1 Period Relevant time frame for the claim --></billablePeriod> <created value="[dateTime]"/><!-- 1..1 Resource creation date --> <enterer><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) Author of the claim --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer> <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Party responsible for the claim --></provider> <priority><!-- 0..1 CodeableConcept Desired processing urgency --></priority> <fundsReserve><!-- 0..1 CodeableConcept For whom to reserve funds --></fundsReserve> <related> <!-- 0..* Prior or corollary claims --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier File or case reference --></reference> </related><|<prescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest|ServiceRequest| VisionPrescription) Prescription authorizing services and products --></prescription> <originalPrescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest|</originalPrescription>ServiceRequest|VisionPrescription) Original prescription if superseded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Recipient of benefits payable --> <type><!-- 1..1 CodeableConcept Category of recipient --></type> <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Recipient reference --></party> </payee> <referral><!-- 0..1 Reference(ServiceRequest) Treatment referral --></referral> <encounter><!-- 0..* Reference(Encounter) Encounters associated with the listed treatments --></encounter> <facility><!-- 0..1 Reference(Location|Organization) Servicing facility --></facility> <diagnosisRelatedGroup><!-- 0..1 CodeableConcept Package billing code --></diagnosisRelatedGroup> <event> <!-- 0..* Event information --> <type><!-- 1..1 CodeableConcept Specific event --></type> <when[x]><!-- 1..1 dateTime|Period Occurance date or period --></when[x]> </event> <careTeam> <!-- 0..* Members of the care team --> <sequence value="[positiveInt]"/><!-- 1..1 Order of care team --> <provider><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Practitioner or organization --></provider><<role><!-- 0..1 CodeableConcept Function within the team --></role> <specialty><!-- 0..1 CodeableConcept Practitioner or provider specialization --></specialty> </careTeam> <supportingInfo> <!-- 0..* Supporting information --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept Classification of the supplied information --></category> <subCategory><!-- 0..1 CodeableConcept Finer-grained classification of the supplied information --></subCategory> <code><!-- 0..1 CodeableConcept Type of information --></code><</timing[x]> <)| </value[x]><timing[x]><!-- 0..1 dateTime|Period|Timing When it occurred --></timing[x]> <value[x]><!-- 0..1 * Data to be provided --></value[x]> <reason><!-- 0..1 CodeableConcept Explanation for the information --></reason> </supportingInfo> <diagnosis> <!-- 0..* Pertinent diagnosis information --> <sequence value="[positiveInt]"/><!-- 1..1 Diagnosis instance identifier --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Nature of illness or problem --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <onAdmission><!-- 0..1 CodeableConcept Present on admission --></onAdmission> </diagnosis> <procedure> <!-- 0..* Clinical procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure instance identifier --> <type><!-- 0..* CodeableConcept Category of Procedure --></type> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Specific clinical procedure --></procedure[x]> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </procedure> <insurance> <!-- 0..* Patient insurance information --> <sequence value="[positiveInt]"/><!-- 1..1 Insurance instance identifier --> <focal value="[boolean]"/><!-- 1..1 Coverage to be used for adjudication --> <identifier><!-- 0..1 Identifier Pre-assigned Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Additional provider contract number --> <preAuthRef value="[string]"/><!-- 0..* Prior authorization reference number --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details of the event --> <date value="[date]"/><!-- 1..1 When the incident occurred --><</type><type><!-- 0..1 CodeableConcept The nature of the accident--></type> <location[x]><!-- 0..1 Address|Reference(Location) Where the event occurred --></location[x]> </accident> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <item> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <subject><!-- 0..1 Reference(Group|Patient) The recipient of the products and services --></subject> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careTeam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <request><!-- 0..* Reference(DeviceRequest|MedicationRequest|NutritionOrder|
</request>ServiceRequest|VisionPrescription) Request or Referral for Service --></request> <modifier><!-- 0..* CodeableConcept Product or service billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of service or product delivery --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service or where product was supplied --></location[x]> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <bodySite> <!-- 0..* Anatomical location --> <site><!-- 1..* CodeableReference(BodyStructure) Location --></site> <subSite><!-- 0..* CodeableConcept Sub-location --></subSite> </bodySite> <encounter><!-- 0..* Reference(Encounter) Encounters associated with the listed treatments --></encounter> <detail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <subDetail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </subDetail> </detail> </item> <total><!-- 0..1 Money Total claim cost --></total> </Claim>
JSON Template
{
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for claim
"traceNumber" : [{ Identifier }], // Number for tracking
"status" : "<code>", // R! active | cancelled | draft | entered-in-error
"statusReason" : "<string>", // Reason for status change
"type" : { CodeableConcept }, // R! Category or discipline
"subType" : { CodeableConcept }, // More granular claim type
"use" : "<code>", // R! claim | preauthorization | predetermination
"
"subject" : { Reference(Group|Patient) }, // R! The recipient(s) of the products and services
"billablePeriod" : { Period }, // Relevant time frame for the claim
"created" : "<dateTime>", // R! Resource creation date
"enterer" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Author of the claim
"insurer" : { Reference(Organization) }, // Target
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Party responsible for the claim
"priority" : { CodeableConcept }, // Desired processing urgency
"fundsReserve" : { CodeableConcept }, // For whom to reserve funds
"related" : [{ // Prior or corollary claims
"claim" : { Reference(Claim) }, // Reference to the related claim
"relationship" : { CodeableConcept }, // How the reference claim is related
"reference" : { Identifier } // File or case reference
}],
"|
"prescription" : { Reference(DeviceRequest|MedicationRequest|ServiceRequest|
VisionPrescription) }, // Prescription authorizing services and products
"originalPrescription" : { Reference(DeviceRequest|MedicationRequest|
ServiceRequest|VisionPrescription) }, // Original prescription if superseded by fulfiller
"payee" : { // Recipient of benefits payable
"type" : { CodeableConcept }, // R! Category of recipient
"party" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson) } // Recipient reference
},
"referral" : { Reference(ServiceRequest) }, // Treatment referral
"encounter" : [{ Reference(Encounter) }], // Encounters associated with the listed treatments
"facility" : { Reference(Location|Organization) }, // Servicing facility
"diagnosisRelatedGroup" : { CodeableConcept }, // Package billing code
"event" : [{ // Event information
"type" : { CodeableConcept }, // R! Specific event
// when[x]: Occurance date or period. One of these 2:
"whenDateTime" : "<dateTime>",
"whenPeriod" : { Period }
}],
"careTeam" : [{ // Members of the care team
"sequence" : "<positiveInt>", // R! Order of care team
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // R! Practitioner or organization
"
"role" : { CodeableConcept }, // Function within the team
"specialty" : { CodeableConcept } // Practitioner or provider specialization
}],
"supportingInfo" : [{ // Supporting information
"sequence" : "<positiveInt>", // R! Information instance identifier
"category" : { CodeableConcept }, // R! Classification of the supplied information
"subCategory" : { CodeableConcept }, // Finer-grained classification of the supplied information
"code" : { CodeableConcept }, // Type of information
">",
// timing[x]: When it occurred. One of these 3:
"timingDateTime" : "<dateTime>",
"timingPeriod" : { Period },
"timingTiming" : { Timing },
// value[x]: Data to be provided. One of these 55:
"valueBase64Binary" : "<base64Binary>",
"valueBoolean" : <boolean>,
"valueCanonical" : "<canonical>",
"valueCode" : "<code>",
"valueDate" : "<date>",
"valueDateTime" : "<dateTime>",
"valueDecimal" : <decimal>,
"valueId" : "<id>",
"valueInstant" : "<instant>",
"valueInteger" : <integer>,
"valueInteger64" : "<integer64>",
"valueMarkdown" : "<markdown>",
"valueOid" : "<oid>",
"valuePositiveInt" : "<positiveInt>",
"valueString" : "<string>",
" },
"valueTime" : "<time>",
"valueUnsignedInt" : "<unsignedInt>",
"valueUri" : "<uri>",
"valueUrl" : "<url>",
"valueUuid" : "<uuid>",
"valueAddress" : { Address },
"valueAge" : { Age },
"valueAnnotation" : { Annotation },
"valueAttachment" : { Attachment },
" },
"valueCodeableConcept" : { CodeableConcept },
"valueCodeableReference" : { CodeableReference },
"valueCoding" : { Coding },
"valueContactPoint" : { ContactPoint },
"valueCount" : { Count },
"valueDistance" : { Distance },
"valueDuration" : { Duration },
"valueHumanName" : { HumanName },
"valueIdentifier" : { Identifier },
"valueMoney" : { Money },
"valuePeriod" : { Period },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueRatioRange" : { RatioRange },
"valueReference" : { Reference },
"valueSampledData" : { SampledData },
"valueSignature" : { Signature },
"valueTiming" : { Timing },
"valueContactDetail" : { ContactDetail },
"valueDataRequirement" : { DataRequirement },
"valueExpression" : { Expression },
"valueParameterDefinition" : { ParameterDefinition },
"valueRelatedArtifact" : { RelatedArtifact },
"valueTriggerDefinition" : { TriggerDefinition },
"valueUsageContext" : { UsageContext },
"valueAvailability" : { Availability },
"valueExtendedContactDetail" : { ExtendedContactDetail },
"valueVirtualServiceDetail" : { VirtualServiceDetail },
"valueDosage" : { Dosage },
"valueMeta" : { Meta },
"reason" : { CodeableConcept } // Explanation for the information
}],
"diagnosis" : [{ // Pertinent diagnosis information
"sequence" : "<positiveInt>", // R! Diagnosis instance identifier
// diagnosis[x]: Nature of illness or problem. One of these 2:
"diagnosisCodeableConcept" : { CodeableConcept },
"diagnosisReference" : { Reference(Condition) },
"type" : [{ CodeableConcept }], // Timing or nature of the diagnosis
"onAdmission" : { CodeableConcept } // Present on admission
}],
"procedure" : [{ // Clinical procedures performed
"sequence" : "<positiveInt>", // R! Procedure instance identifier
"type" : [{ CodeableConcept }], // Category of Procedure
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Specific clinical procedure. One of these 2:
"procedureCodeableConcept" : { CodeableConcept },
"procedureReference" : { Reference(Procedure) },
"udi" : [{ Reference(Device) }] // Unique device identifier
}],
"insurance" : [{ // Patient insurance information
"sequence" : "<positiveInt>", // R! Insurance instance identifier
"focal" : <boolean>, // R! Coverage to be used for adjudication
"identifier" : { Identifier }, // Pre-assigned Claim number
"coverage" : { Reference(Coverage) }, // R! Insurance information
"businessArrangement" : "<string>", // Additional provider contract number
"preAuthRef" : ["<string>"], // Prior authorization reference number
"claimResponse" : { Reference(ClaimResponse) } // Adjudication results
}],
"accident" : { // Details of the event
"date" : "<date>", // R! When the incident occurred
"
"type" : { CodeableConcept }, // The nature of the accident
// location[x]: Where the event occurred. One of these 2:
"locationAddress" : { Address },
"locationReference" : { Reference(Location) }
},
"patientPaid" : { Money }, // Paid by the patient
"item" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"subject" : { Reference(Group|Patient) }, // The recipient of the products and services
"careTeamSequence" : ["<positiveInt>"], // Applicable careTeam members
"diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses
"procedureSequence" : ["<positiveInt>"], // Applicable procedures
"informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"request" : [{ Reference(DeviceRequest|MedicationRequest|NutritionOrder|
ServiceRequest|VisionPrescription) }], // Request or Referral for Service
"modifier" : [{ CodeableConcept }], // Product or service billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
// serviced[x]: Date or dates of service or product delivery. One of these 2:
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
// location[x]: Place of service or where product was supplied. One of these 3:
"locationCodeableConcept" : { CodeableConcept },
"locationAddress" : { Address },
"locationReference" : { Reference(Location) },
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique device identifier
"bodySite" : [{ // Anatomical location
"site" : [{ CodeableReference(BodyStructure) }], // R! Location
"subSite" : [{ CodeableConcept }] // Sub-location
}],
"encounter" : [{ Reference(Encounter) }], // Encounters associated with the listed treatments
"detail" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique device identifier
"subDetail" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }] // Unique device identifier
}]
}]
}],
"total" : { Money } // Total claim cost
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for claim fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:status [ code ] ; # 1..1 active | cancelled | draft | entered-in-error fhir:statusReason [ string ] ; # 0..1 Reason for status change fhir:type [ CodeableConcept ] ; # 1..1 Category or discipline fhir:subType [ CodeableConcept ] ; # 0..1 More granular claim type fhir:use [ code ] ; # 1..1 claim | preauthorization | predeterminationfhir:fhir:subject [ Reference(Group|Patient) ] ; # 1..1 The recipient(s) of the products and services fhir:billablePeriod [ Period ] ; # 0..1 Relevant time frame for the claim fhir:created [ dateTime ] ; # 1..1 Resource creation date fhir:enterer [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Author of the claim fhir:insurer [ Reference(Organization) ] ; # 0..1 Target fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Party responsible for the claim fhir:priority [ CodeableConcept ] ; # 0..1 Desired processing urgency fhir:fundsReserve [ CodeableConcept ] ; # 0..1 For whom to reserve funds fhir:related ( [ # 0..* Prior or corollary claims fhir:claim [ Reference(Claim) ] ; # 0..1 Reference to the related claim fhir:relationship [ CodeableConcept ] ; # 0..1 How the reference claim is related fhir:reference [ Identifier ] ; # 0..1 File or case reference ] ... ) ;fhir: fhir:fhir:prescription [ Reference(DeviceRequest|MedicationRequest|ServiceRequest|VisionPrescription) ] ; # 0..1 Prescription authorizing services and products fhir:originalPrescription [ Reference(DeviceRequest|MedicationRequest|ServiceRequest|VisionPrescription) ] ; # 0..1 Original prescription if superseded by fulfiller fhir:payee [ # 0..1 Recipient of benefits payable fhir:type [ CodeableConcept ] ; # 1..1 Category of recipient fhir:party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Recipient reference ] ; fhir:referral [ Reference(ServiceRequest) ] ; # 0..1 Treatment referral fhir:encounter ( [ Reference(Encounter) ] ... ) ; # 0..* Encounters associated with the listed treatments fhir:facility [ Reference(Location|Organization) ] ; # 0..1 Servicing facility fhir:diagnosisRelatedGroup [ CodeableConcept ] ; # 0..1 Package billing code fhir:event ( [ # 0..* Event information fhir:type [ CodeableConcept ] ; # 1..1 Specific event # when[x] : 1..1 Occurance date or period. One of these 2fhir: ]fhir:when [ a fhir:DateTime ; dateTime ] fhir:when [ a fhir:Period ; Period ] ] ... ) ; fhir:careTeam ( [ # 0..* Members of the care team fhir:sequence [ positiveInt ] ; # 1..1 Order of care team fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 1..1 Practitioner or organizationfhir:fhir:role [ CodeableConcept ] ; # 0..1 Function within the team fhir:specialty [ CodeableConcept ] ; # 0..1 Practitioner or provider specialization ] ... ) ; fhir:supportingInfo ( [ # 0..* Supporting information fhir:sequence [ positiveInt ] ; # 1..1 Information instance identifier fhir:category [ CodeableConcept ] ; # 1..1 Classification of the supplied information fhir:subCategory [ CodeableConcept ] ; # 0..1 Finer-grained classification of the supplied information fhir:code [ CodeableConcept ] ; # 0..1 Type of information# . One of these 2 fhir: ]# timing[x] : 0..1 When it occurred. One of these 3 fhir:timing [ a fhir:DateTime ; dateTime ] fhir:timing [ a fhir:Period ; Period ]# . One of these 6 fhir: ] fhir: ] fhir: ]fhir:timing [ a fhir:Timing ; Timing ] # value[x] : 0..1 Data to be provided. One of these 55 fhir:value [ a fhir:Base64Binary ; base64Binary ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Canonical ; canonical ] fhir:value [ a fhir:Code ; code ] fhir:value [ a fhir:Date ; date ] fhir:value [ a fhir:DateTime ; dateTime ] fhir:value [ a fhir:Decimal ; decimal ] fhir:value [ a fhir:Id ; id ] fhir:value [ a fhir:Instant ; instant ] fhir:value [ a fhir:Integer ; integer ] fhir:value [ a fhir:Integer64 ; integer64 ] fhir:value [ a fhir:Markdown ; markdown ] fhir:value [ a fhir:Oid ; oid ] fhir:value [ a fhir:PositiveInt ; positiveInt ] fhir:value [ a fhir:String ; string ] fhir:value [ a fhir:Time ; time ] fhir:value [ a fhir:UnsignedInt ; unsignedInt ] fhir:value [ a fhir:Uri ; uri ] fhir:value [ a fhir:Url ; url ] fhir:value [ a fhir:Uuid ; uuid ] fhir:value [ a fhir:Address ; Address ] fhir:value [ a fhir:Age ; Age ] fhir:value [ a fhir:Annotation ; Annotation ] fhir:value [ a fhir:Attachment ; Attachment ]fhir:) ]fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:CodeableReference ; CodeableReference ] fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:ContactPoint ; ContactPoint ] fhir:value [ a fhir:Count ; Count ] fhir:value [ a fhir:Distance ; Distance ] fhir:value [ a fhir:Duration ; Duration ] fhir:value [ a fhir:HumanName ; HumanName ] fhir:value [ a fhir:Identifier ; Identifier ] fhir:value [ a fhir:Money ; Money ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Ratio ; Ratio ] fhir:value [ a fhir:RatioRange ; RatioRange ] fhir:value [ a fhir:Reference ; Reference ] fhir:value [ a fhir:SampledData ; SampledData ] fhir:value [ a fhir:Signature ; Signature ] fhir:value [ a fhir:Timing ; Timing ] fhir:value [ a fhir:ContactDetail ; ContactDetail ] fhir:value [ a fhir:DataRequirement ; DataRequirement ] fhir:value [ a fhir:Expression ; Expression ] fhir:value [ a fhir:ParameterDefinition ; ParameterDefinition ] fhir:value [ a fhir:RelatedArtifact ; RelatedArtifact ] fhir:value [ a fhir:TriggerDefinition ; TriggerDefinition ] fhir:value [ a fhir:UsageContext ; UsageContext ] fhir:value [ a fhir:Availability ; Availability ] fhir:value [ a fhir:ExtendedContactDetail ; ExtendedContactDetail ] fhir:value [ a fhir:VirtualServiceDetail ; VirtualServiceDetail ] fhir:value [ a fhir:Dosage ; Dosage ] fhir:value [ a fhir:Meta ; Meta ] fhir:reason [ CodeableConcept ] ; # 0..1 Explanation for the information ] ... ) ; fhir:diagnosis ( [ # 0..* Pertinent diagnosis information fhir:sequence [ positiveInt ] ; # 1..1 Diagnosis instance identifier # diagnosis[x] : 1..1 Nature of illness or problem. One of these 2 fhir:diagnosis [ a fhir:CodeableConcept ; CodeableConcept ] fhir:diagnosis [ a fhir:Reference ; Reference(Condition) ] fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Timing or nature of the diagnosis fhir:onAdmission [ CodeableConcept ] ; # 0..1 Present on admission ] ... ) ; fhir:procedure ( [ # 0..* Clinical procedures performed fhir:sequence [ positiveInt ] ; # 1..1 Procedure instance identifier fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Category of Procedure fhir:date [ dateTime ] ; # 0..1 When the procedure was performed # procedure[x] : 1..1 Specific clinical procedure. One of these 2 fhir:procedure [ a fhir:CodeableConcept ; CodeableConcept ] fhir:procedure [ a fhir:Reference ; Reference(Procedure) ] fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier ] ... ) ; fhir:insurance ( [ # 0..* Patient insurance information fhir:sequence [ positiveInt ] ; # 1..1 Insurance instance identifier fhir:focal [ boolean ] ; # 1..1 Coverage to be used for adjudication fhir:identifier [ Identifier ] ; # 0..1 Pre-assigned Claim number fhir:coverage [ Reference(Coverage) ] ; # 1..1 Insurance information fhir:businessArrangement [ string ] ; # 0..1 Additional provider contract number fhir:preAuthRef ( [ string ] ... ) ; # 0..* Prior authorization reference number fhir:claimResponse [ Reference(ClaimResponse) ] ; # 0..1 Adjudication results ] ... ) ; fhir:accident [ # 0..1 Details of the event fhir:date [ date ] ; # 1..1 When the incident occurred fhir:type [ CodeableConcept ] ; # 0..1 The nature of the accident # location[x] : 0..1 Where the event occurred. One of these 2 fhir:location [ a fhir:Address ; Address ] fhir:location [ a fhir:Reference ; Reference(Location) ] ] ; fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:item ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:subject [ Reference(Group|Patient) ] ; # 0..1 The recipient of the products and services fhir:careTeamSequence ( [ positiveInt ] ... ) ; # 0..* Applicable careTeam members fhir:diagnosisSequence ( [ positiveInt ] ... ) ; # 0..* Applicable diagnoses fhir:procedureSequence ( [ positiveInt ] ... ) ; # 0..* Applicable procedures fhir:informationSequence ( [ positiveInt ] ... ) ; # 0..* Applicable exception and supporting information fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codesfhir:|fhir:request ( [ Reference(DeviceRequest|MedicationRequest|NutritionOrder|ServiceRequest|VisionPrescription) ] ... ) ; # 0..* Request or Referral for Service fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Product or service billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under # serviced[x] : 0..1 Date or dates of service or product delivery. One of these 2fhir: ]fhir:serviced [ a fhir:Date ; date ] fhir:serviced [ a fhir:Period ; Period ] # location[x] : 0..1 Place of service or where product was supplied. One of these 3 fhir:location [ a fhir:CodeableConcept ; CodeableConcept ] fhir:location [ a fhir:Address ; Address ] fhir:location [ a fhir:Reference ; Reference(Location) ] fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier fhir:bodySite ( [ # 0..* Anatomical location fhir:site ( [ CodeableReference(BodyStructure) ] ... ) ; # 1..* Location fhir:subSite ( [ CodeableConcept ] ... ) ; # 0..* Sub-location ] ... ) ; fhir:encounter ( [ Reference(Encounter) ] ... ) ; # 0..* Encounters associated with the listed treatments fhir:detail ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codes fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Service/Product billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier fhir:subDetail ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codes fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Service/Product billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier ] ... ) ; ] ... ) ; ] ... ) ; fhir:total [ Money ] ; # 0..1 Total claim cost ]
Changes from both R4 and R4B
| Claim | |
| Claim.traceNumber |
|
| Claim.statusReason |
|
| Claim.subject |
|
| Claim.enterer |
|
| Claim.provider |
|
| Claim.priority |
|
| Claim.prescription |
|
| Claim.originalPrescription |
|
| Claim.encounter |
|
| Claim.facility |
|
| Claim.diagnosisRelatedGroup |
|
| Claim.event |
|
| Claim.event.type |
|
| Claim.event.when[x] |
|
| Claim.careTeam.specialty |
|
| Claim.supportingInfo.subCategory |
|
|
|
|
| Claim.supportingInfo.value[x] |
|
| Claim.insurance |
|
| Claim.patientPaid |
|
| Claim.item.traceNumber |
|
| Claim.item.subject |
|
| Claim.item.productOrService |
|
| Claim.item.productOrServiceEnd |
|
| Claim.item.request |
|
| Claim.item.patientPaid |
|
| Claim.item.tax |
|
| Claim.item.bodySite |
|
| Claim.item.bodySite.site |
|
| Claim.item.bodySite.subSite |
|
| Claim.item.detail.traceNumber |
|
| Claim.item.detail.productOrService |
|
| Claim.item.detail.productOrServiceEnd |
|
| Claim.item.detail.patientPaid |
|
| Claim.item.detail.tax |
|
| Claim.item.detail.subDetail.traceNumber |
|
| Claim.item.detail.subDetail.productOrService |
|
| Claim.item.detail.subDetail.productOrServiceEnd |
|
| Claim.item.detail.subDetail.patientPaid |
|
| Claim.item.detail.subDetail.tax |
|
|
|
|
| Claim.careTeam.responsible |
|
| Claim.careTeam.qualification |
|
| Claim.diagnosis.packageCode |
|
| Claim.item.subSite |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
TU | DomainResource |
Claim,
Pre-determination
or
Pre-authorization
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..* | Identifier |
Business
Identifier
for
claim
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
?! Σ | 1..1 | code |
active
|
cancelled
|
draft
|
entered-in-error
Binding: Financial Resource Status Codes ( Required ) |
| Σ | 0..1 | string |
Reason
for
status
change
|
![]() ![]() |
Σ | 1..1 | CodeableConcept |
Category
or
discipline
Binding: Claim Type Codes ( Extensible ) |
|
0..1 | CodeableConcept |
More
granular
claim
type
Binding: Example Claim SubType Codes ( Example ) |
|
|
Σ | 1..1 | code |
claim
|
preauthorization
|
predetermination
Binding: Use ( Required ) |
|
Σ | 1..1 | Reference ( Patient | Group ) |
The
|
|
Σ | 0..1 | Period |
Relevant
time
frame
for
the
claim
|
|
Σ | 1..1 | dateTime |
Resource
creation
date
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson ) |
Author
of
the
claim
|
|
|
Σ | 0..1 | Reference ( Organization ) |
Target
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Party
responsible
for
the
claim
|
|
Σ | 0..1 | CodeableConcept |
Desired
processing
urgency
Binding: Process Priority Codes ( |
|
0..1 | CodeableConcept |
For
whom
to
reserve
funds
Binding: Funds Reservation Codes ( |
|
|
0..* | BackboneElement |
Prior
or
corollary
claims
|
|
|
0..1 | Reference ( Claim ) |
Reference
to
the
related
claim
|
|
|
0..1 | CodeableConcept |
How
the
reference
claim
is
related
Binding: Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier |
File
or
case
reference
|
|
|
0..1 | Reference ( DeviceRequest | MedicationRequest | ServiceRequest | VisionPrescription ) |
Prescription
authorizing
services
and
products
|
|
|
0..1 | Reference ( DeviceRequest | MedicationRequest | ServiceRequest | VisionPrescription ) |
Original
prescription
if
superseded
by
fulfiller
|
|
|
0..1 | BackboneElement |
Recipient
of
benefits
payable
|
|
|
1..1 | CodeableConcept |
Category
of
recipient
Binding: Claim Payee Type Codes ( Example ) |
|
|
0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson ) |
Recipient
reference
|
|
|
0..1 | Reference ( ServiceRequest ) |
Treatment
referral
|
|
|
0..* | Reference ( Encounter ) |
Encounters
associated
with
the
listed
treatments
|
|
|
0..1 | Reference ( Location | Organization ) |
Servicing
facility
|
|
|
0..1 | CodeableConcept |
Package
billing
code
Binding: Example Diagnosis Related Group Codes ( Example ) |
|
|
0..* | BackboneElement |
Event
information
|
|
|
1..1 | CodeableConcept |
Specific
event
Binding: Dates Type Codes ( Example ) |
|
|
1..1 |
Occurance
date
or
period
|
||
|
dateTime | |||
|
Period | |||
|
0..* | BackboneElement |
Members
of
the
care
team
|
|
|
1..1 | positiveInt |
Order
of
care
team
|
|
|
1..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Practitioner
or
organization
|
|
|
0..1 | CodeableConcept |
Function
within
the
team
Binding: Claim Care Team Role Codes ( |
|
|
0..1 | CodeableConcept |
Practitioner
or
provider
specialization
Binding: Example Provider Qualification Codes ( Example ) |
|
|
0..* | BackboneElement |
Supporting
information
|
|
|
1..1 | positiveInt |
Information
instance
identifier
|
|
|
1..1 | CodeableConcept |
Classification
of
the
supplied
information
Binding: Claim Information Category Codes ( |
|
|
0..1 | CodeableConcept |
Finer-grained
classification
of
the
supplied
information
Binding: |
|
|
0..1 | CodeableConcept |
Type
of
information
|
|
|
0..1 |
When
it
occurred
|
||
|
|
|||
|
|
|||
|
|
|||
|
|
0..1 |
|
Data
to
be
provided
|
|
0..1 | CodeableConcept |
Explanation
for
the
information
Binding: Missing Tooth Reason Codes ( Example ) |
|
|
0..* | BackboneElement |
Pertinent
diagnosis
information
|
|
|
1..1 | positiveInt |
Diagnosis
instance
identifier
|
|
|
1..1 |
Nature
of
illness
or
problem
Binding: ICD-10 Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Condition ) | |||
|
0..* | CodeableConcept |
Timing
or
nature
of
the
diagnosis
Binding: Example Diagnosis Type Codes ( |
|
|
0..1 | CodeableConcept |
Present
on
admission
Binding: Example Diagnosis on Admission Codes ( |
|
|
0..* | BackboneElement |
Clinical
procedures
performed
|
|
|
1..1 | positiveInt |
Procedure
instance
identifier
|
|
|
0..* | CodeableConcept |
Category
of
Procedure
Binding: Example Procedure Type Codes ( |
|
|
0..1 | dateTime |
When
the
procedure
was
performed
|
|
|
1..1 |
Specific
clinical
procedure
Binding: ICD-10 Procedure Codes ( Example ) |
||
|
CodeableConcept | |||
|
Reference ( Procedure ) | |||
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
Σ | 0..* | BackboneElement |
Patient
insurance
information
|
|
Σ | 1..1 | positiveInt |
Insurance
instance
identifier
|
|
Σ | 1..1 | boolean |
Coverage
to
be
used
for
adjudication
|
|
0..1 | Identifier |
Pre-assigned
Claim
number
|
|
|
Σ | 1..1 | Reference ( Coverage ) |
Insurance
information
|
|
0..1 | string |
Additional
provider
contract
number
|
|
|
0..* | string |
Prior
authorization
reference
number
|
|
|
0..1 | Reference ( ClaimResponse ) |
Adjudication
results
|
|
|
0..1 | BackboneElement |
Details
of
the
event
|
|
|
1..1 | date |
When
the
incident
occurred
|
|
|
0..1 | CodeableConcept |
The
nature
of
the
accident
Binding: ActIncidentCode
(
Extensible
)
|
|
|
0..1 |
Where
the
event
occurred
|
||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
| 0..1 | Reference ( Patient | Group ) |
The
recipient
of
the
products
and
services
| |
![]() ![]() ![]() |
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
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* |
Reference
(
DeviceRequest
|
MedicationRequest
|
NutritionOrder
|
ServiceRequest
|
|
Request
or
Referral
for
Service
|
|
|
0..* | CodeableConcept |
Product
or
service
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 |
Date
or
dates
of
service
or
product
delivery
|
||
|
date | |||
|
Period | |||
|
0..1 |
Place
of
service
or
where
product
was
supplied
Binding: Example Service Place Codes ( Example ) |
||
|
CodeableConcept | |||
|
Address | |||
|
Reference ( Location ) | |||
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..* | BackboneElement |
Anatomical
location
|
|
|
1..* | CodeableReference ( BodyStructure ) |
Location
Binding: Oral Site Codes ( Example ) |
|
|
0..* | CodeableConcept |
Sub-location
Binding: Surface Codes ( Example ) |
|
|
0..* | Reference ( Encounter ) |
Encounters
associated
with
the
listed
treatments
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..* | BackboneElement |
Product
or
service
provided
|
|
|
1..1 | positiveInt |
Item
instance
identifier
|
|
|
0..* | Identifier |
Number
for
tracking
|
|
|
0..1 | CodeableConcept |
Revenue
or
cost
center
code
Binding: Example Revenue Center Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Benefit
classification
Binding: Benefit Category Codes ( Example ) |
|
|
0..1 | CodeableConcept |
Billing,
service,
product,
or
drug
code
Binding: USCLS Codes ( Example ) |
|
|
0..1 | CodeableConcept |
End
of
a
range
of
codes
Binding: USCLS Codes ( Example ) |
|
|
0..* | CodeableConcept |
Service/Product
billing
modifiers
Binding: Modifier type Codes ( Example ) |
|
|
0..* | CodeableConcept |
Program
the
product
or
service
is
provided
under
Binding: Example Program Reason Codes ( Example ) |
|
|
0..1 | Money |
Paid
by
the
patient
|
|
|
0..1 | SimpleQuantity |
Count
of
products
or
services
|
|
|
0..1 | Money |
Fee,
charge
or
cost
per
item
|
|
|
0..1 | decimal |
Price
scaling
factor
|
|
|
0..1 | Money |
Total
tax
|
|
|
0..1 | Money |
Total
item
cost
|
|
|
0..* | Reference ( Device ) |
Unique
device
identifier
|
|
|
0..1 | Money |
Total
claim
cost
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<Claim xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Business Identifier for claim --></identifier> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <statusReason value="[string]"/><!-- 0..1 Reason for status change --> <type><!-- 1..1 CodeableConcept Category or discipline --></type> <subType><!-- 0..1 CodeableConcept More granular claim type --></subType> <use value="[code]"/><!-- 1..1 claim | preauthorization | predetermination -->
<</patient><subject><!-- 1..1 Reference(Group|Patient) The recipient(s) of the products and services --></subject> <billablePeriod><!-- 0..1 Period Relevant time frame for the claim --></billablePeriod> <created value="[dateTime]"/><!-- 1..1 Resource creation date --> <enterer><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) Author of the claim --></enterer> <insurer><!-- 0..1 Reference(Organization) Target --></insurer> <provider><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Party responsible for the claim --></provider> <priority><!-- 0..1 CodeableConcept Desired processing urgency --></priority> <fundsReserve><!-- 0..1 CodeableConcept For whom to reserve funds --></fundsReserve> <related> <!-- 0..* Prior or corollary claims --> <claim><!-- 0..1 Reference(Claim) Reference to the related claim --></claim> <relationship><!-- 0..1 CodeableConcept How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier File or case reference --></reference> </related><|<prescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest|ServiceRequest| VisionPrescription) Prescription authorizing services and products --></prescription> <originalPrescription><!-- 0..1 Reference(DeviceRequest|MedicationRequest|</originalPrescription>ServiceRequest|VisionPrescription) Original prescription if superseded by fulfiller --></originalPrescription> <payee> <!-- 0..1 Recipient of benefits payable --> <type><!-- 1..1 CodeableConcept Category of recipient --></type> <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) Recipient reference --></party> </payee> <referral><!-- 0..1 Reference(ServiceRequest) Treatment referral --></referral> <encounter><!-- 0..* Reference(Encounter) Encounters associated with the listed treatments --></encounter> <facility><!-- 0..1 Reference(Location|Organization) Servicing facility --></facility> <diagnosisRelatedGroup><!-- 0..1 CodeableConcept Package billing code --></diagnosisRelatedGroup> <event> <!-- 0..* Event information --> <type><!-- 1..1 CodeableConcept Specific event --></type> <when[x]><!-- 1..1 dateTime|Period Occurance date or period --></when[x]> </event> <careTeam> <!-- 0..* Members of the care team --> <sequence value="[positiveInt]"/><!-- 1..1 Order of care team --> <provider><!-- 1..1 Reference(Organization|Practitioner|PractitionerRole) Practitioner or organization --></provider><<role><!-- 0..1 CodeableConcept Function within the team --></role> <specialty><!-- 0..1 CodeableConcept Practitioner or provider specialization --></specialty> </careTeam> <supportingInfo> <!-- 0..* Supporting information --> <sequence value="[positiveInt]"/><!-- 1..1 Information instance identifier --> <category><!-- 1..1 CodeableConcept Classification of the supplied information --></category> <subCategory><!-- 0..1 CodeableConcept Finer-grained classification of the supplied information --></subCategory> <code><!-- 0..1 CodeableConcept Type of information --></code><</timing[x]> <)| </value[x]><timing[x]><!-- 0..1 dateTime|Period|Timing When it occurred --></timing[x]> <value[x]><!-- 0..1 * Data to be provided --></value[x]> <reason><!-- 0..1 CodeableConcept Explanation for the information --></reason> </supportingInfo> <diagnosis> <!-- 0..* Pertinent diagnosis information --> <sequence value="[positiveInt]"/><!-- 1..1 Diagnosis instance identifier --> <diagnosis[x]><!-- 1..1 CodeableConcept|Reference(Condition) Nature of illness or problem --></diagnosis[x]> <type><!-- 0..* CodeableConcept Timing or nature of the diagnosis --></type> <onAdmission><!-- 0..1 CodeableConcept Present on admission --></onAdmission> </diagnosis> <procedure> <!-- 0..* Clinical procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure instance identifier --> <type><!-- 0..* CodeableConcept Category of Procedure --></type> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 CodeableConcept|Reference(Procedure) Specific clinical procedure --></procedure[x]> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </procedure> <insurance> <!-- 0..* Patient insurance information --> <sequence value="[positiveInt]"/><!-- 1..1 Insurance instance identifier --> <focal value="[boolean]"/><!-- 1..1 Coverage to be used for adjudication --> <identifier><!-- 0..1 Identifier Pre-assigned Claim number --></identifier> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Additional provider contract number --> <preAuthRef value="[string]"/><!-- 0..* Prior authorization reference number --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> </insurance> <accident> <!-- 0..1 Details of the event --> <date value="[date]"/><!-- 1..1 When the incident occurred --><</type><type><!-- 0..1 CodeableConcept The nature of the accident--></type> <location[x]><!-- 0..1 Address|Reference(Location) Where the event occurred --></location[x]> </accident> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <item> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <subject><!-- 0..1 Reference(Group|Patient) The recipient of the products and services --></subject> <careTeamSequence value="[positiveInt]"/><!-- 0..* Applicable careTeam members --> <diagnosisSequence value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <procedureSequence value="[positiveInt]"/><!-- 0..* Applicable procedures --> <informationSequence value="[positiveInt]"/><!-- 0..* Applicable exception and supporting information --> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <request><!-- 0..* Reference(DeviceRequest|MedicationRequest|NutritionOrder|
</request>ServiceRequest|VisionPrescription) Request or Referral for Service --></request> <modifier><!-- 0..* CodeableConcept Product or service billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of service or product delivery --></serviced[x]> <location[x]><!-- 0..1 CodeableConcept|Address|Reference(Location) Place of service or where product was supplied --></location[x]> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <bodySite> <!-- 0..* Anatomical location --> <site><!-- 1..* CodeableReference(BodyStructure) Location --></site> <subSite><!-- 0..* CodeableConcept Sub-location --></subSite> </bodySite> <encounter><!-- 0..* Reference(Encounter) Encounters associated with the listed treatments --></encounter> <detail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> <subDetail> <!-- 0..* Product or service provided --> <sequence value="[positiveInt]"/><!-- 1..1 Item instance identifier --> <traceNumber><!-- 0..* Identifier Number for tracking --></traceNumber> <revenue><!-- 0..1 CodeableConcept Revenue or cost center code --></revenue> <category><!-- 0..1 CodeableConcept Benefit classification --></category> <productOrService><!-- 0..1 CodeableConcept Billing, service, product, or drug code --></productOrService> <productOrServiceEnd><!-- 0..1 CodeableConcept End of a range of codes --></productOrServiceEnd> <modifier><!-- 0..* CodeableConcept Service/Product billing modifiers --></modifier> <programCode><!-- 0..* CodeableConcept Program the product or service is provided under --></programCode> <patientPaid><!-- 0..1 Money Paid by the patient --></patientPaid> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of products or services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per item --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <tax><!-- 0..1 Money Total tax --></tax> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique device identifier --></udi> </subDetail> </detail> </item> <total><!-- 0..1 Money Total claim cost --></total> </Claim>
JSON Template
{
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for claim
"traceNumber" : [{ Identifier }], // Number for tracking
"status" : "<code>", // R! active | cancelled | draft | entered-in-error
"statusReason" : "<string>", // Reason for status change
"type" : { CodeableConcept }, // R! Category or discipline
"subType" : { CodeableConcept }, // More granular claim type
"use" : "<code>", // R! claim | preauthorization | predetermination
"
"subject" : { Reference(Group|Patient) }, // R! The recipient(s) of the products and services
"billablePeriod" : { Period }, // Relevant time frame for the claim
"created" : "<dateTime>", // R! Resource creation date
"enterer" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) }, // Author of the claim
"insurer" : { Reference(Organization) }, // Target
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // Party responsible for the claim
"priority" : { CodeableConcept }, // Desired processing urgency
"fundsReserve" : { CodeableConcept }, // For whom to reserve funds
"related" : [{ // Prior or corollary claims
"claim" : { Reference(Claim) }, // Reference to the related claim
"relationship" : { CodeableConcept }, // How the reference claim is related
"reference" : { Identifier } // File or case reference
}],
"|
"prescription" : { Reference(DeviceRequest|MedicationRequest|ServiceRequest|
VisionPrescription) }, // Prescription authorizing services and products
"originalPrescription" : { Reference(DeviceRequest|MedicationRequest|
ServiceRequest|VisionPrescription) }, // Original prescription if superseded by fulfiller
"payee" : { // Recipient of benefits payable
"type" : { CodeableConcept }, // R! Category of recipient
"party" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson) } // Recipient reference
},
"referral" : { Reference(ServiceRequest) }, // Treatment referral
"encounter" : [{ Reference(Encounter) }], // Encounters associated with the listed treatments
"facility" : { Reference(Location|Organization) }, // Servicing facility
"diagnosisRelatedGroup" : { CodeableConcept }, // Package billing code
"event" : [{ // Event information
"type" : { CodeableConcept }, // R! Specific event
// when[x]: Occurance date or period. One of these 2:
"whenDateTime" : "<dateTime>",
"whenPeriod" : { Period }
}],
"careTeam" : [{ // Members of the care team
"sequence" : "<positiveInt>", // R! Order of care team
"provider" : { Reference(Organization|Practitioner|PractitionerRole) }, // R! Practitioner or organization
"
"role" : { CodeableConcept }, // Function within the team
"specialty" : { CodeableConcept } // Practitioner or provider specialization
}],
"supportingInfo" : [{ // Supporting information
"sequence" : "<positiveInt>", // R! Information instance identifier
"category" : { CodeableConcept }, // R! Classification of the supplied information
"subCategory" : { CodeableConcept }, // Finer-grained classification of the supplied information
"code" : { CodeableConcept }, // Type of information
">",
// timing[x]: When it occurred. One of these 3:
"timingDateTime" : "<dateTime>",
"timingPeriod" : { Period },
"timingTiming" : { Timing },
// value[x]: Data to be provided. One of these 55:
"valueBase64Binary" : "<base64Binary>",
"valueBoolean" : <boolean>,
"valueCanonical" : "<canonical>",
"valueCode" : "<code>",
"valueDate" : "<date>",
"valueDateTime" : "<dateTime>",
"valueDecimal" : <decimal>,
"valueId" : "<id>",
"valueInstant" : "<instant>",
"valueInteger" : <integer>,
"valueInteger64" : "<integer64>",
"valueMarkdown" : "<markdown>",
"valueOid" : "<oid>",
"valuePositiveInt" : "<positiveInt>",
"valueString" : "<string>",
" },
"valueTime" : "<time>",
"valueUnsignedInt" : "<unsignedInt>",
"valueUri" : "<uri>",
"valueUrl" : "<url>",
"valueUuid" : "<uuid>",
"valueAddress" : { Address },
"valueAge" : { Age },
"valueAnnotation" : { Annotation },
"valueAttachment" : { Attachment },
" },
"valueCodeableConcept" : { CodeableConcept },
"valueCodeableReference" : { CodeableReference },
"valueCoding" : { Coding },
"valueContactPoint" : { ContactPoint },
"valueCount" : { Count },
"valueDistance" : { Distance },
"valueDuration" : { Duration },
"valueHumanName" : { HumanName },
"valueIdentifier" : { Identifier },
"valueMoney" : { Money },
"valuePeriod" : { Period },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueRatioRange" : { RatioRange },
"valueReference" : { Reference },
"valueSampledData" : { SampledData },
"valueSignature" : { Signature },
"valueTiming" : { Timing },
"valueContactDetail" : { ContactDetail },
"valueDataRequirement" : { DataRequirement },
"valueExpression" : { Expression },
"valueParameterDefinition" : { ParameterDefinition },
"valueRelatedArtifact" : { RelatedArtifact },
"valueTriggerDefinition" : { TriggerDefinition },
"valueUsageContext" : { UsageContext },
"valueAvailability" : { Availability },
"valueExtendedContactDetail" : { ExtendedContactDetail },
"valueVirtualServiceDetail" : { VirtualServiceDetail },
"valueDosage" : { Dosage },
"valueMeta" : { Meta },
"reason" : { CodeableConcept } // Explanation for the information
}],
"diagnosis" : [{ // Pertinent diagnosis information
"sequence" : "<positiveInt>", // R! Diagnosis instance identifier
// diagnosis[x]: Nature of illness or problem. One of these 2:
"diagnosisCodeableConcept" : { CodeableConcept },
"diagnosisReference" : { Reference(Condition) },
"type" : [{ CodeableConcept }], // Timing or nature of the diagnosis
"onAdmission" : { CodeableConcept } // Present on admission
}],
"procedure" : [{ // Clinical procedures performed
"sequence" : "<positiveInt>", // R! Procedure instance identifier
"type" : [{ CodeableConcept }], // Category of Procedure
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Specific clinical procedure. One of these 2:
"procedureCodeableConcept" : { CodeableConcept },
"procedureReference" : { Reference(Procedure) },
"udi" : [{ Reference(Device) }] // Unique device identifier
}],
"insurance" : [{ // Patient insurance information
"sequence" : "<positiveInt>", // R! Insurance instance identifier
"focal" : <boolean>, // R! Coverage to be used for adjudication
"identifier" : { Identifier }, // Pre-assigned Claim number
"coverage" : { Reference(Coverage) }, // R! Insurance information
"businessArrangement" : "<string>", // Additional provider contract number
"preAuthRef" : ["<string>"], // Prior authorization reference number
"claimResponse" : { Reference(ClaimResponse) } // Adjudication results
}],
"accident" : { // Details of the event
"date" : "<date>", // R! When the incident occurred
"
"type" : { CodeableConcept }, // The nature of the accident
// location[x]: Where the event occurred. One of these 2:
"locationAddress" : { Address },
"locationReference" : { Reference(Location) }
},
"patientPaid" : { Money }, // Paid by the patient
"item" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"subject" : { Reference(Group|Patient) }, // The recipient of the products and services
"careTeamSequence" : ["<positiveInt>"], // Applicable careTeam members
"diagnosisSequence" : ["<positiveInt>"], // Applicable diagnoses
"procedureSequence" : ["<positiveInt>"], // Applicable procedures
"informationSequence" : ["<positiveInt>"], // Applicable exception and supporting information
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"request" : [{ Reference(DeviceRequest|MedicationRequest|NutritionOrder|
ServiceRequest|VisionPrescription) }], // Request or Referral for Service
"modifier" : [{ CodeableConcept }], // Product or service billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
// serviced[x]: Date or dates of service or product delivery. One of these 2:
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
// location[x]: Place of service or where product was supplied. One of these 3:
"locationCodeableConcept" : { CodeableConcept },
"locationAddress" : { Address },
"locationReference" : { Reference(Location) },
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique device identifier
"bodySite" : [{ // Anatomical location
"site" : [{ CodeableReference(BodyStructure) }], // R! Location
"subSite" : [{ CodeableConcept }] // Sub-location
}],
"encounter" : [{ Reference(Encounter) }], // Encounters associated with the listed treatments
"detail" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique device identifier
"subDetail" : [{ // Product or service provided
"sequence" : "<positiveInt>", // R! Item instance identifier
"traceNumber" : [{ Identifier }], // Number for tracking
"revenue" : { CodeableConcept }, // Revenue or cost center code
"category" : { CodeableConcept }, // Benefit classification
"productOrService" : { CodeableConcept }, // Billing, service, product, or drug code
"productOrServiceEnd" : { CodeableConcept }, // End of a range of codes
"modifier" : [{ CodeableConcept }], // Service/Product billing modifiers
"programCode" : [{ CodeableConcept }], // Program the product or service is provided under
"patientPaid" : { Money }, // Paid by the patient
"quantity" : { Quantity(SimpleQuantity) }, // Count of products or services
"unitPrice" : { Money }, // Fee, charge or cost per item
"factor" : <decimal>, // Price scaling factor
"tax" : { Money }, // Total tax
"net" : { Money }, // Total item cost
"udi" : [{ Reference(Device) }] // Unique device identifier
}]
}]
}],
"total" : { Money } // Total claim cost
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for claim fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:status [ code ] ; # 1..1 active | cancelled | draft | entered-in-error fhir:statusReason [ string ] ; # 0..1 Reason for status change fhir:type [ CodeableConcept ] ; # 1..1 Category or discipline fhir:subType [ CodeableConcept ] ; # 0..1 More granular claim type fhir:use [ code ] ; # 1..1 claim | preauthorization | predeterminationfhir:fhir:subject [ Reference(Group|Patient) ] ; # 1..1 The recipient(s) of the products and services fhir:billablePeriod [ Period ] ; # 0..1 Relevant time frame for the claim fhir:created [ dateTime ] ; # 1..1 Resource creation date fhir:enterer [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Author of the claim fhir:insurer [ Reference(Organization) ] ; # 0..1 Target fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Party responsible for the claim fhir:priority [ CodeableConcept ] ; # 0..1 Desired processing urgency fhir:fundsReserve [ CodeableConcept ] ; # 0..1 For whom to reserve funds fhir:related ( [ # 0..* Prior or corollary claims fhir:claim [ Reference(Claim) ] ; # 0..1 Reference to the related claim fhir:relationship [ CodeableConcept ] ; # 0..1 How the reference claim is related fhir:reference [ Identifier ] ; # 0..1 File or case reference ] ... ) ;fhir: fhir:fhir:prescription [ Reference(DeviceRequest|MedicationRequest|ServiceRequest|VisionPrescription) ] ; # 0..1 Prescription authorizing services and products fhir:originalPrescription [ Reference(DeviceRequest|MedicationRequest|ServiceRequest|VisionPrescription) ] ; # 0..1 Original prescription if superseded by fulfiller fhir:payee [ # 0..1 Recipient of benefits payable fhir:type [ CodeableConcept ] ; # 1..1 Category of recipient fhir:party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Recipient reference ] ; fhir:referral [ Reference(ServiceRequest) ] ; # 0..1 Treatment referral fhir:encounter ( [ Reference(Encounter) ] ... ) ; # 0..* Encounters associated with the listed treatments fhir:facility [ Reference(Location|Organization) ] ; # 0..1 Servicing facility fhir:diagnosisRelatedGroup [ CodeableConcept ] ; # 0..1 Package billing code fhir:event ( [ # 0..* Event information fhir:type [ CodeableConcept ] ; # 1..1 Specific event # when[x] : 1..1 Occurance date or period. One of these 2fhir: ]fhir:when [ a fhir:DateTime ; dateTime ] fhir:when [ a fhir:Period ; Period ] ] ... ) ; fhir:careTeam ( [ # 0..* Members of the care team fhir:sequence [ positiveInt ] ; # 1..1 Order of care team fhir:provider [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 1..1 Practitioner or organizationfhir:fhir:role [ CodeableConcept ] ; # 0..1 Function within the team fhir:specialty [ CodeableConcept ] ; # 0..1 Practitioner or provider specialization ] ... ) ; fhir:supportingInfo ( [ # 0..* Supporting information fhir:sequence [ positiveInt ] ; # 1..1 Information instance identifier fhir:category [ CodeableConcept ] ; # 1..1 Classification of the supplied information fhir:subCategory [ CodeableConcept ] ; # 0..1 Finer-grained classification of the supplied information fhir:code [ CodeableConcept ] ; # 0..1 Type of information# . One of these 2 fhir: ]# timing[x] : 0..1 When it occurred. One of these 3 fhir:timing [ a fhir:DateTime ; dateTime ] fhir:timing [ a fhir:Period ; Period ]# . One of these 6 fhir: ] fhir: ] fhir: ]fhir:timing [ a fhir:Timing ; Timing ] # value[x] : 0..1 Data to be provided. One of these 55 fhir:value [ a fhir:Base64Binary ; base64Binary ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Canonical ; canonical ] fhir:value [ a fhir:Code ; code ] fhir:value [ a fhir:Date ; date ] fhir:value [ a fhir:DateTime ; dateTime ] fhir:value [ a fhir:Decimal ; decimal ] fhir:value [ a fhir:Id ; id ] fhir:value [ a fhir:Instant ; instant ] fhir:value [ a fhir:Integer ; integer ] fhir:value [ a fhir:Integer64 ; integer64 ] fhir:value [ a fhir:Markdown ; markdown ] fhir:value [ a fhir:Oid ; oid ] fhir:value [ a fhir:PositiveInt ; positiveInt ] fhir:value [ a fhir:String ; string ] fhir:value [ a fhir:Time ; time ] fhir:value [ a fhir:UnsignedInt ; unsignedInt ] fhir:value [ a fhir:Uri ; uri ] fhir:value [ a fhir:Url ; url ] fhir:value [ a fhir:Uuid ; uuid ] fhir:value [ a fhir:Address ; Address ] fhir:value [ a fhir:Age ; Age ] fhir:value [ a fhir:Annotation ; Annotation ] fhir:value [ a fhir:Attachment ; Attachment ]fhir:) ]fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:CodeableReference ; CodeableReference ] fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:ContactPoint ; ContactPoint ] fhir:value [ a fhir:Count ; Count ] fhir:value [ a fhir:Distance ; Distance ] fhir:value [ a fhir:Duration ; Duration ] fhir:value [ a fhir:HumanName ; HumanName ] fhir:value [ a fhir:Identifier ; Identifier ] fhir:value [ a fhir:Money ; Money ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Ratio ; Ratio ] fhir:value [ a fhir:RatioRange ; RatioRange ] fhir:value [ a fhir:Reference ; Reference ] fhir:value [ a fhir:SampledData ; SampledData ] fhir:value [ a fhir:Signature ; Signature ] fhir:value [ a fhir:Timing ; Timing ] fhir:value [ a fhir:ContactDetail ; ContactDetail ] fhir:value [ a fhir:DataRequirement ; DataRequirement ] fhir:value [ a fhir:Expression ; Expression ] fhir:value [ a fhir:ParameterDefinition ; ParameterDefinition ] fhir:value [ a fhir:RelatedArtifact ; RelatedArtifact ] fhir:value [ a fhir:TriggerDefinition ; TriggerDefinition ] fhir:value [ a fhir:UsageContext ; UsageContext ] fhir:value [ a fhir:Availability ; Availability ] fhir:value [ a fhir:ExtendedContactDetail ; ExtendedContactDetail ] fhir:value [ a fhir:VirtualServiceDetail ; VirtualServiceDetail ] fhir:value [ a fhir:Dosage ; Dosage ] fhir:value [ a fhir:Meta ; Meta ] fhir:reason [ CodeableConcept ] ; # 0..1 Explanation for the information ] ... ) ; fhir:diagnosis ( [ # 0..* Pertinent diagnosis information fhir:sequence [ positiveInt ] ; # 1..1 Diagnosis instance identifier # diagnosis[x] : 1..1 Nature of illness or problem. One of these 2 fhir:diagnosis [ a fhir:CodeableConcept ; CodeableConcept ] fhir:diagnosis [ a fhir:Reference ; Reference(Condition) ] fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Timing or nature of the diagnosis fhir:onAdmission [ CodeableConcept ] ; # 0..1 Present on admission ] ... ) ; fhir:procedure ( [ # 0..* Clinical procedures performed fhir:sequence [ positiveInt ] ; # 1..1 Procedure instance identifier fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Category of Procedure fhir:date [ dateTime ] ; # 0..1 When the procedure was performed # procedure[x] : 1..1 Specific clinical procedure. One of these 2 fhir:procedure [ a fhir:CodeableConcept ; CodeableConcept ] fhir:procedure [ a fhir:Reference ; Reference(Procedure) ] fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier ] ... ) ; fhir:insurance ( [ # 0..* Patient insurance information fhir:sequence [ positiveInt ] ; # 1..1 Insurance instance identifier fhir:focal [ boolean ] ; # 1..1 Coverage to be used for adjudication fhir:identifier [ Identifier ] ; # 0..1 Pre-assigned Claim number fhir:coverage [ Reference(Coverage) ] ; # 1..1 Insurance information fhir:businessArrangement [ string ] ; # 0..1 Additional provider contract number fhir:preAuthRef ( [ string ] ... ) ; # 0..* Prior authorization reference number fhir:claimResponse [ Reference(ClaimResponse) ] ; # 0..1 Adjudication results ] ... ) ; fhir:accident [ # 0..1 Details of the event fhir:date [ date ] ; # 1..1 When the incident occurred fhir:type [ CodeableConcept ] ; # 0..1 The nature of the accident # location[x] : 0..1 Where the event occurred. One of these 2 fhir:location [ a fhir:Address ; Address ] fhir:location [ a fhir:Reference ; Reference(Location) ] ] ; fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:item ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:subject [ Reference(Group|Patient) ] ; # 0..1 The recipient of the products and services fhir:careTeamSequence ( [ positiveInt ] ... ) ; # 0..* Applicable careTeam members fhir:diagnosisSequence ( [ positiveInt ] ... ) ; # 0..* Applicable diagnoses fhir:procedureSequence ( [ positiveInt ] ... ) ; # 0..* Applicable procedures fhir:informationSequence ( [ positiveInt ] ... ) ; # 0..* Applicable exception and supporting information fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codesfhir:|fhir:request ( [ Reference(DeviceRequest|MedicationRequest|NutritionOrder|ServiceRequest|VisionPrescription) ] ... ) ; # 0..* Request or Referral for Service fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Product or service billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under # serviced[x] : 0..1 Date or dates of service or product delivery. One of these 2fhir: ]fhir:serviced [ a fhir:Date ; date ] fhir:serviced [ a fhir:Period ; Period ] # location[x] : 0..1 Place of service or where product was supplied. One of these 3 fhir:location [ a fhir:CodeableConcept ; CodeableConcept ] fhir:location [ a fhir:Address ; Address ] fhir:location [ a fhir:Reference ; Reference(Location) ] fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier fhir:bodySite ( [ # 0..* Anatomical location fhir:site ( [ CodeableReference(BodyStructure) ] ... ) ; # 1..* Location fhir:subSite ( [ CodeableConcept ] ... ) ; # 0..* Sub-location ] ... ) ; fhir:encounter ( [ Reference(Encounter) ] ... ) ; # 0..* Encounters associated with the listed treatments fhir:detail ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codes fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Service/Product billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier fhir:subDetail ( [ # 0..* Product or service provided fhir:sequence [ positiveInt ] ; # 1..1 Item instance identifier fhir:traceNumber ( [ Identifier ] ... ) ; # 0..* Number for tracking fhir:revenue [ CodeableConcept ] ; # 0..1 Revenue or cost center code fhir:category [ CodeableConcept ] ; # 0..1 Benefit classification fhir:productOrService [ CodeableConcept ] ; # 0..1 Billing, service, product, or drug code fhir:productOrServiceEnd [ CodeableConcept ] ; # 0..1 End of a range of codes fhir:modifier ( [ CodeableConcept ] ... ) ; # 0..* Service/Product billing modifiers fhir:programCode ( [ CodeableConcept ] ... ) ; # 0..* Program the product or service is provided under fhir:patientPaid [ Money ] ; # 0..1 Paid by the patient fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Count of products or services fhir:unitPrice [ Money ] ; # 0..1 Fee, charge or cost per item fhir:factor [ decimal ] ; # 0..1 Price scaling factor fhir:tax [ Money ] ; # 0..1 Total tax fhir:net [ Money ] ; # 0..1 Total item cost fhir:udi ( [ Reference(Device) ] ... ) ; # 0..* Unique device identifier ] ... ) ; ] ... ) ; ] ... ) ; fhir:total [ Money ] ; # 0..1 Total claim cost ]
Changes from both R4 and R4B
| Claim | |
| Claim.traceNumber |
|
| Claim.statusReason |
|
| Claim.subject |
|
| Claim.enterer |
|
| Claim.provider |
|
| Claim.priority |
|
| Claim.prescription |
|
| Claim.originalPrescription |
|
| Claim.encounter |
|
| Claim.facility |
|
| Claim.diagnosisRelatedGroup |
|
| Claim.event |
|
| Claim.event.type |
|
| Claim.event.when[x] |
|
| Claim.careTeam.specialty |
|
| Claim.supportingInfo.subCategory |
|
|
|
|
| Claim.supportingInfo.value[x] |
|
| Claim.insurance |
|
| Claim.patientPaid |
|
| Claim.item.traceNumber |
|
| Claim.item.subject |
|
| Claim.item.productOrService |
|
| Claim.item.productOrServiceEnd |
|
| Claim.item.request |
|
| Claim.item.patientPaid |
|
| Claim.item.tax |
|
| Claim.item.bodySite |
|
| Claim.item.bodySite.site |
|
| Claim.item.bodySite.subSite |
|
| Claim.item.detail.traceNumber |
|
| Claim.item.detail.productOrService |
|
| Claim.item.detail.productOrServiceEnd |
|
| Claim.item.detail.patientPaid |
|
| Claim.item.detail.tax |
|
| Claim.item.detail.subDetail.traceNumber |
|
| Claim.item.detail.subDetail.productOrService |
|
| Claim.item.detail.subDetail.productOrServiceEnd |
|
| Claim.item.detail.subDetail.patientPaid |
|
| Claim.item.detail.subDetail.tax |
|
|
|
|
| Claim.careTeam.responsible |
|
| Claim.careTeam.qualification |
|
| Claim.diagnosis.packageCode |
|
| Claim.item.subSite |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| Claim.status | FinancialResourceStatusCodes | Required |
This value set includes Status codes. |
| Claim.type | ClaimTypeCodes | Extensible |
This value set includes Claim Type codes. |
| Claim.subType | ExampleClaimSubTypeCodes | Example |
This value set includes sample Claim SubType codes which are used to distinguish the claim types for example within type institutional there may be subtypes for emergency services, bed stay and transportation. |
| Claim.use | Use | Required |
The purpose of the Claim: predetermination, preauthorization, claim. |
| Claim.priority | ProcessPriorityCodes |
|
This value set includes the financial processing priority codes. |
| Claim.fundsReserve | FundsReservationCodes |
|
This
value
set
includes
|
| Claim.related.relationship | ExampleRelatedClaimRelationshipCodes | Example |
This value set includes sample Related Claim Relationship codes. |
| Claim.payee.type |
ClaimPayeeTypeCodes
(a
valid
code
from
Payee
Type
Codes
)
|
Example |
This value set includes sample Payee Type codes. |
| Claim.diagnosisRelatedGroup | ExampleDiagnosisRelatedGroupCodes | Example |
This value set includes example Diagnosis Related Group codes. |
| Claim.event.type | DatesTypeCodes (a valid code from Dates Event Type Codes ) | Example |
This value set includes sample Dates Type codes. |
| Claim.careTeam.role | ClaimCareTeamRoleCodes |
|
This value set includes sample Claim Care Team Role codes. |
| Claim.careTeam.specialty | ExampleProviderQualificationCodes | Example |
This value set includes sample Provider Qualification codes. |
| Claim.supportingInfo.category | ClaimInformationCategoryCodes |
|
This value set includes sample Information Category codes. |
| Claim.supportingInfo.subCategory | Example | ||
| Claim.supportingInfo.code | ExceptionCodes | Example |
This value set includes sample Exception codes. |
| Claim.supportingInfo.reason | MissingToothReasonCodes | Example |
This value set includes sample Missing Tooth Reason codes. |
| Claim.diagnosis.diagnosis[x] |
ICD10Codes
(a
valid
code
from
ICD-10
)
|
Example |
This value set includes sample ICD-10 codes. |
| Claim.diagnosis.type | ExampleDiagnosisTypeCodes |
|
This value set includes example Diagnosis Type codes. |
| Claim.diagnosis.onAdmission | ExampleDiagnosisOnAdmissionCodes |
|
This value set includes example Diagnosis on Admission codes. |
| Claim.procedure.type | ExampleProcedureTypeCodes |
|
This value set includes example Procedure Type codes. |
| Claim.procedure.procedure[x] | ICD10ProcedureCodes (a valid code from ICD-10 Procedure Codes ) | Example |
This value set includes sample ICD-10 Procedure codes. |
| Claim.accident.type |
ActIncidentCode
|
Extensible |
Set of codes indicating the type of incident or accident. |
| Claim.item.revenue | ExampleRevenueCenterCodes | Example |
This value set includes sample Revenue Center codes. |
| Claim.item.category | BenefitCategoryCodes | Example |
This value set includes examples of Benefit Category codes. |
| Claim.item.productOrService | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.productOrServiceEnd | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.modifier | ModifierTypeCodes | Example |
This value set includes sample Modifier type codes. |
| Claim.item.programCode | ExampleProgramReasonCodes | Example |
This value set includes sample Program Reason Span codes. |
| Claim.item.location[x] | ExampleServicePlaceCodes | Example |
This value set includes a smattering of Service Place codes. |
| Claim.item.bodySite.site | OralSiteCodes | Example |
This value set includes a smattering of FDI oral site codes. |
| Claim.item.bodySite.subSite | SurfaceCodes | Example |
This value set includes a smattering of FDI tooth surface codes. |
| Claim.item.detail.revenue | ExampleRevenueCenterCodes | Example |
This value set includes sample Revenue Center codes. |
| Claim.item.detail.category | BenefitCategoryCodes | Example |
This value set includes examples of Benefit Category codes. |
| Claim.item.detail.productOrService | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.detail.productOrServiceEnd | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.detail.modifier | ModifierTypeCodes | Example |
This value set includes sample Modifier type codes. |
| Claim.item.detail.programCode | ExampleProgramReasonCodes | Example |
This value set includes sample Program Reason Span codes. |
| Claim.item.detail.subDetail.revenue | ExampleRevenueCenterCodes | Example |
This value set includes sample Revenue Center codes. |
| Claim.item.detail.subDetail.category | BenefitCategoryCodes | Example |
This value set includes examples of Benefit Category codes. |
| Claim.item.detail.subDetail.productOrService | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.detail.subDetail.productOrServiceEnd | USCLSCodes | Example |
This value set includes a smattering of USCLS codes. |
| Claim.item.detail.subDetail.modifier | ModifierTypeCodes | Example |
This value set includes sample Modifier type codes. |
| Claim.item.detail.subDetail.programCode | ExampleProgramReasonCodes | Example |
This value set includes sample Program Reason Span codes. |
The information presented in different backbone elements, such as .supportingInfo or .adjudication , has a different context based on the .category code presented in each, for example, adjudication occurrence may represent an amount paid by the patient while another may represent the amount paid to the provider.
Additionally, there are several places in the resource which point to other sections of the resource via the use of a .sequence number in the referred-to element and an . element Sequence in the referring element. Sequence numbers appear in such element as .careTeam referred to by .careTeamSequence , .diagnosis referred to by .diagnosisSequence , .procedure referred to by .procedureSequence , .supportingInfo referred to by .informationSequence and .item referred to by .itemSequence .
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 | |
| detail-udi | reference | UDI associated with a line item, detail product or service |
Claim.item.detail.udi
( Device ) |
|
| encounter | reference | Encounters associated with a billed line item |
Claim.item.encounter
( Encounter ) |
|
| enterer | reference | The party responsible for the entry of the Claim |
Claim.enterer
( Practitioner , Patient , PractitionerRole , RelatedPerson ) |
|
| facility | reference | Facility where the products or services have been or will be provided |
Claim.facility
( Organization , Location ) |
|
| group | reference | Group receiving the products or services |
Claim.subject.where(resolve()
is
Group)
|
Claim.item.subject.where(resolve()
is
Group)
( Group , Patient ) |
|
| identifier | token | The primary identifier of the financial resource | Claim.identifier |
|
| insurer | reference |
The
target
|
Claim.insurer
( Organization ) |
|
| item-udi | reference | UDI associated with a line item product or service |
Claim.item.udi
( Device ) |
|
| patient | reference | Patient receiving the products or services |
( Group , Patient ) |
|
| payee | reference | The party receiving any payment for the Claim |
Claim.payee.party
( Practitioner , Organization , Patient , PractitionerRole , RelatedPerson ) |
|
| priority | token | Processing priority requested | Claim.priority | |
| procedure-udi | reference | UDI associated with a procedure |
Claim.procedure.udi
( Device ) |
|
| provider | reference | Provider responsible for the Claim |
Claim.provider
( Practitioner , Organization , PractitionerRole ) |
|
| status | token | The status of the Claim instance. | Claim.status | |
| subdetail-udi | reference | UDI associated with a line item, detail, subdetail product or service |
Claim.item.detail.subDetail.udi
( Device ) |
|
| subject | reference | Subject receiving the products or services |
Claim.subject
|
Claim.item.subject
( Group , Patient ) | |
| use | token | The kind of financial resource | Claim.use |