This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
The OralHealthClaim is one of a suite of similar resources (VisionClaim, PharmacyClaim, ProfessionalClaim, InstitutionalClaim) which are used by providers to exchange the financial information, and supporting clinical information, regarding the provision of healthcare services. The primary uses of this resource is to support eClaims, the exchange of proposed or actual services to benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
The Claim is intended to support:
The Claim also supports:
Todo
This resource is referenced by
ClaimResponse
and
and
ExplanationOfBenefit
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | code |
ClaimType |
|
Σ | 0..* | Coding |
Finer grained claim type information
Example Claim SubType Codes ( Example ) |
![]() ![]() |
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Period | Period for charge submission |
![]() ![]() |
Σ | 0..1 | Insurer | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | Responsible provider | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
Σ | 0..1 | Responsible organization | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | code |
Use |
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Author | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
Σ | 0..1 | Servicing Facility | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Location ) | |||
|
|
0..* | BackboneElement | Related Claims which may be revelant to processing this claimn |
|
Σ | 0..1 | Reference to the related claim | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() |
Reference
(
| |||
![]() ![]() ![]() | Σ | 0..1 | Coding |
How the reference claim is related
Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier | Related file or case reference |
|
Σ | 0..1 | Prescription | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( MedicationOrder | VisionPrescription ) | |||
|
|
0..1 | Original Prescription | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( MedicationOrder ) | |||
|
Σ | 0..1 | BackboneElement |
|
|
Σ |
|
Coding |
|
|
Σ | 0..1 | Party to receive the payable | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Practitioner | Organization | Patient | RelatedPerson ) | |||
|
Σ | 0..1 | Treatment Referral | |
![]() ![]() ![]() |
|
|||
|
Reference ( ReferralRequest ) | |||
|
Σ |
|
|
Example Occurrance Codes ( Example ) |
|
Σ |
|
|
Occurrence Span Codes
Example Occurrance Span Codes ( Example ) |
|
|
0..* | Coding |
Value Codes
Example Value Codes ( Example ) |
|
Σ | 0..* | BackboneElement | Diagnosis |
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() | Σ | 0..* | BackboneElement | Procedures performed |
![]() ![]() ![]() | Σ | 1..1 | positiveInt | Procedure sequence for reference |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When the procedure was performed |
![]() ![]() ![]() | Σ | 1..1 |
Patient's list of procedures performed
ICD-10 Procedure Codes ( Example ) |
|
| Coding | |||
|
Reference ( Procedure ) | |||
![]() ![]() |
Σ | 0..* | Coding |
|
|
Σ | 1..1 | The subject of the Products and Services | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Patient ) | |||
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | boolean |
|
|
Σ | 1..1 | Insurance information | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Coverage ) | |||
|
Σ | 0..1 | string |
|
|
Σ |
|
|
|
| Σ | 0..1 |
Reference
(
|
Adjudication results |
|
Σ |
|
|
Ruleset Codes ( Example ) |
|
Σ | 0..1 |
|
|
|
Σ | 0..1 | Coding |
|
![]() ![]() | Σ | 0..1 | Accident Place | |
![]() ![]() ![]() | Address | |||
![]() ![]() ![]() |
Reference
(
|
|||
|
Σ | 0..* | Coding |
|
|
Σ |
|
|
|
|
Σ | 0..1 | Illness, injury or treatable condition date | |
![]() ![]() ![]() ![]() | date | |||
|
|
|||
|
Σ | 0..1 | Coding |
|
|
Σ |
|
|
|
|
Σ | 0..1 |
Period
|
Period in hospital |
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 0..1 | Responsible practitioner | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Practitioner ) | |||
![]() ![]() ![]() |
Σ | 0..1 | Supervising Practitioner | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
|
0..1 | Coding |
Type, classification or Specialization
Example Provider Qualification Codes ( Example ) |
|
Σ | 0..* | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ |
|
|
Example Service Modifier Codes ( Example ) |
|
Σ |
|
|
Modifier type Codes ( Example ) |
|
Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
![]() ![]() ![]() |
Σ | 0..1 | Date or dates of Service | |
| date | |||
|
|
|||
|
Σ | 0..1 |
|
Example Service Place Codes ( Example ) |
|
Σ | 0..1 |
|
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 |
|
|
|
Σ | 0..1 |
decimal
|
Difficulty scaling factor |
|
Σ | 0..1 |
|
|
| Σ | 0..* |
Reference
(
|
Unique Device Identifier |
|
Σ |
|
Coding |
|
|
Σ | 0..* | Coding |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() ![]() ![]() | Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | Money |
|
|
Σ |
|
|
Unique Device Identifier |
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | Money |
|
|
Σ |
|
|
Unique Device Identifier |
|
Σ | 0..1 | BackboneElement |
|
|
Σ | 0..1 | boolean |
|
|
Σ | 0..1 | date |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Money | Total claim cost |
![]() ![]() |
Σ | 0..* | Coding |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | date |
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<Claim xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< <</identifier><type value="[code]"/><!-- 1..1 institutional | oral | pharmacy | professional | vision --> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --><</target> <</provider> <</organization><billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <target[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></target[x]> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible provider --></provider[x]> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></organization[x]> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --><</priority><priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve><</enterer> <</facility> <</prescription> <</originalPrescription> < <</type> <</provider> <</organization> <</person><enterer[x]><!-- 0..1 Identifier|Reference(Practitioner) Author --></enterer[x]> <facility[x]><!-- 0..1 Identifier|Reference(Location) Servicing Facility --></facility[x]> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Reference to the related claim --></claim[x]> <relationship><!-- 0..1 Coding How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder| VisionPrescription) Prescription --></prescription[x]> <originalPrescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder) Original Prescription --></originalPrescription[x]> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 1..1 Coding Type of party: Subscriber, Provider, other --></type> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee><</referral><referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <occurrenceCode><!-- 0..* Coding Occurrence Codes --></occurrenceCode> <occurenceSpanCode><!-- 0..* Coding Occurrence Span Codes --></occurenceSpanCode> <valueCode><!-- 0..* Coding Value Codes --></valueCode> <diagnosis> <!-- 0..* Diagnosis --><<sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis><</condition> <</patient><procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <specialCondition><!-- 0..* Coding List of special Conditions --></specialCondition> <patient[x]><!-- 1..1 Identifier|Reference(Patient) The subject of the Products and Services --></patient[x]> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier -->< <</coverage><focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage[x]><!-- 1..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --><</relationship><preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage><</exception> < < <</accidentType><accidentDate value="[date]"/><!-- 0..1 When the accident occurred --> <accidentType><!-- 0..1 Coding The nature of the accident --></accidentType> <accidentLocation[x]><!-- 0..1 Address|Reference(Location) Accident Place --></accidentLocation[x]> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <onset> <!-- 0..* Condition related Onset related dates and codes --> <time[x]><!-- 0..1 date|Period Illness, injury or treatable condition date --></time[x]> <type><!-- 0..1 Coding Onset of what --></type> </onset> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type> <</provider> <<type><!-- 1..1 Coding Group or type of product or service --></type> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></provider[x]> <supervisor[x]><!-- 0..1 Identifier|Reference(Practitioner) Supervising Practitioner --></supervisor[x]> <providerQualification><!-- 0..1 Coding Type, classification or Specialization --></providerQualification> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <service><!-- 1..1 Coding Item Code --></service><<serviceModifier><!-- 0..* Coding Service/Product modifiers --></serviceModifier> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <place><!-- 0..1 Coding Place of service --></place> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi> <</bodySite> <</subSite> <</modifier><net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type><type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi><net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type> <</service><type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity><</unitPrice><unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi><net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item><</additionalMaterials><total><!-- 0..1 Quantity(Money) Total claim cost --></total> <additionalMaterial><!-- 0..* Coding Additional supporting materials and documents --></additionalMaterial> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth><</reason> <<reason><!-- 0..1 Coding Indicates whether it was extracted or other reason --></reason> <extractionDate value="[date]"/><!-- 0..1 Date tooth was extracted if known --> </missingTeeth> </Claim>
JSON
Template
JSON Template
{
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"type" : "<code>", // R! institutional | oral | pharmacy | professional | vision
"subType" : [{ Coding }], // Finer grained claim type information
"identifier" : [{ Identifier }], // Claim number
"ruleset" : { Coding }, // Current specification followed
"originalRuleset" : { Coding }, // Original specification followed
"created" : "<dateTime>", // Creation date
"
"
"
"billablePeriod" : { Period }, // Period for charge submission
// target[x]: Insurer. One of these 2:
"targetIdentifier" : { Identifier },
"targetReference" : { Reference(Organization) },
// provider[x]: Responsible provider. One of these 2:
"providerIdentifier" : { Identifier },
"providerReference" : { Reference(Practitioner) },
// organization[x]: Responsible organization. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
"use" : "<code>", // complete | proposed | exploratory | other
"
"priority" : { Coding }, // Desired processing priority
"fundsReserve" : { Coding }, // Funds requested to be reserved
"
"
"
"
"
"
"
"
"
// enterer[x]: Author. One of these 2:
"entererIdentifier" : { Identifier },
"entererReference" : { Reference(Practitioner) },
// facility[x]: Servicing Facility. One of these 2:
"facilityIdentifier" : { Identifier },
"facilityReference" : { Reference(Location) },
"related" : [{ // Related Claims which may be revelant to processing this claimn
// claim[x]: Reference to the related claim. One of these 2:
"claimIdentifier" : { Identifier },
"claimReference" : { Reference(Claim) },
"relationship" : { Coding }, // How the reference claim is related
"reference" : { Identifier } // Related file or case reference
}],
// prescription[x]: Prescription. One of these 2:
"prescriptionIdentifier" : { Identifier },
"prescriptionReference" : { Reference(MedicationOrder|VisionPrescription) },
// originalPrescription[x]: Original Prescription. One of these 2:
"originalPrescriptionIdentifier" : { Identifier },
"originalPrescriptionReference" : { Reference(MedicationOrder) },
"payee" : { // Party to be paid any benefits payable
"type" : { Coding }, // R! Type of party: Subscriber, Provider, other
// party[x]: Party to receive the payable. One of these 2:
"partyIdentifier" : { Identifier }
"partyReference" : { Reference(Practitioner|Organization|Patient|RelatedPerson) }
},
"
// referral[x]: Treatment Referral. One of these 2:
"referralIdentifier" : { Identifier },
"referralReference" : { Reference(ReferralRequest) },
"occurrenceCode" : [{ Coding }], // Occurrence Codes
"occurenceSpanCode" : [{ Coding }], // Occurrence Span Codes
"valueCode" : [{ Coding }], // Value Codes
"diagnosis" : [{ // Diagnosis
"
"sequence" : "<positiveInt>", // R! Number to covey order of diagnosis
"diagnosis" : { Coding } // R! Patient's list of diagnosis
}],
"
"
"procedure" : [{ // Procedures performed
"sequence" : "<positiveInt>", // R! Procedure sequence for reference
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Patient's list of procedures performed. One of these 2:
"procedureCoding" : { Coding }
"procedureReference" : { Reference(Procedure) }
}],
"specialCondition" : [{ Coding }], // List of special Conditions
// patient[x]: The subject of the Products and Services. One of these 2:
"patientIdentifier" : { Identifier },
"patientReference" : { Reference(Patient) },
"coverage" : [{ // Insurance or medical plan
"sequence" : "<positiveInt>", // R! Service instance identifier
"
"
"focal" : <boolean>, // R! Is the focal Coverage
// coverage[x]: Insurance information. One of these 2:
"coverageIdentifier" : { Identifier },
"coverageReference" : { Reference(Coverage) },
"businessArrangement" : "<string>", // Business agreement
"
"preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
"claimResponse" : { Reference(ClaimResponse) }, // Adjudication results
"originalRuleset" : { Coding } // Original version
}],
"
"
"
"
"accidentDate" : "<date>", // When the accident occurred
"accidentType" : { Coding }, // The nature of the accident
// accidentLocation[x]: Accident Place. One of these 2:
"accidentLocationAddress" : { Address },
"accidentLocationReference" : { Reference(Location) },
"interventionException" : [{ Coding }], // Intervention and exception code (Pharma)
"onset" : [{ // Condition related Onset related dates and codes
// time[x]: Illness, injury or treatable condition date. One of these 2:
"timeDate" : "<date>",
"timePeriod" : { Period },
"type" : { Coding } // Onset of what
}],
"employmentImpacted" : { Period }, // Period unable to work
"hospitalization" : { Period }, // Period in hospital
"item" : [{ // Goods and Services
"sequence" : "<positiveInt>", // R! Service instance
"
"
"
"type" : { Coding }, // R! Group or type of product or service
// provider[x]: Responsible practitioner. One of these 2:
"providerIdentifier" : { Identifier },
"providerReference" : { Reference(Practitioner) },
// supervisor[x]: Supervising Practitioner. One of these 2:
"supervisorIdentifier" : { Identifier },
"supervisorReference" : { Reference(Practitioner) },
"providerQualification" : { Coding }, // Type, classification or Specialization
"diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses
"service" : { Coding }, // R! Item Code
"
"serviceModifier" : [{ Coding }], // Service/Product modifiers
"modifier" : [{ Coding }], // Service/Product billing modifiers
"programCode" : [{ Coding }], // Program specific reason for item inclusion
// serviced[x]: Date or dates of Service. One of these 2:
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
"place" : { Coding }, // Place of service
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"
"
"
"net" : { Quantity(Money) }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"bodySite" : { Coding }, // Service Location
"subSite" : [{ Coding }], // Service Sub-location
"detail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"
"type" : { Coding }, // R! Group or type of product or service
"service" : { Coding }, // R! Additional item codes
"programCode" : [{ Coding }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"net" : { Quantity(Money) }, // Total additional item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"subDetail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"
"
"type" : { Coding }, // R! Type of product or service
"service" : { Coding }, // R! Additional item codes
"programCode" : [{ Coding }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"net" : { Quantity(Money) }, // Net additional item cost
"udi" : [{ Reference(Device) }] // Unique Device Identifier
}]
}],
"prosthesis" : { // Prosthetic details
"initial" : <boolean>, // Is this the initial service
"priorDate" : "<date>", // Initial service Date
"priorMaterial" : { Coding } // Prosthetic Material
}
}],
"
"total" : { Quantity(Money) }, // Total claim cost
"additionalMaterial" : [{ Coding }], // Additional supporting materials and documents
"missingTeeth" : [{ // Only if type = oral
"tooth" : { Coding }, // R! Tooth Code
"
"
"reason" : { Coding }, // Indicates whether it was extracted or other reason
"extractionDate" : "<date>" // Date tooth was extracted if known
}]
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | code |
ClaimType |
|
Σ | 0..* | Coding |
Finer grained claim type information
Example Claim SubType Codes ( Example ) |
![]() ![]() |
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | Period | Period for charge submission |
![]() ![]() |
Σ | 0..1 | Insurer | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | Responsible provider | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
Σ | 0..1 | Responsible organization | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Organization ) | |||
|
Σ | 0..1 | code |
Use |
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Author | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
Σ | 0..1 | Servicing Facility | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Location ) | |||
|
|
0..* | BackboneElement | Related Claims which may be revelant to processing this claimn |
|
Σ | 0..1 | Reference to the related claim | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() |
Reference
(
| |||
![]() ![]() ![]() | Σ | 0..1 | Coding |
How the reference claim is related
Example Related Claim Relationship Codes ( Example ) |
|
|
0..1 | Identifier | Related file or case reference |
|
Σ | 0..1 | Prescription | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( MedicationOrder | VisionPrescription ) | |||
|
|
0..1 | Original Prescription | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( MedicationOrder ) | |||
|
Σ | 0..1 | BackboneElement |
|
|
Σ |
|
Coding |
|
|
Σ | 0..1 | Party to receive the payable | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Practitioner | Organization | Patient | RelatedPerson ) | |||
|
Σ | 0..1 | Treatment Referral | |
![]() ![]() ![]() |
|
|||
|
Reference ( ReferralRequest ) | |||
|
Σ |
|
|
Example Occurrance Codes ( Example ) |
|
Σ |
|
|
Occurrence Span Codes
Example Occurrance Span Codes ( Example ) |
|
|
0..* | Coding |
Value Codes
Example Value Codes ( Example ) |
|
Σ | 0..* | BackboneElement | Diagnosis |
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() | Σ | 0..* | BackboneElement | Procedures performed |
![]() ![]() ![]() | Σ | 1..1 | positiveInt | Procedure sequence for reference |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When the procedure was performed |
![]() ![]() ![]() | Σ | 1..1 |
Patient's list of procedures performed
ICD-10 Procedure Codes ( Example ) |
|
| Coding | |||
|
Reference ( Procedure ) | |||
![]() ![]() |
Σ | 0..* | Coding |
|
|
Σ | 1..1 | The subject of the Products and Services | |
![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() | Reference ( Patient ) | |||
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | boolean |
|
|
Σ | 1..1 | Insurance information | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Coverage ) | |||
|
Σ | 0..1 | string |
|
|
Σ |
|
|
|
| Σ | 0..1 |
Reference
(
|
Adjudication results |
|
Σ |
|
|
Ruleset Codes ( Example ) |
|
Σ | 0..1 |
|
|
|
Σ | 0..1 | Coding |
|
![]() ![]() | Σ | 0..1 | Accident Place | |
![]() ![]() ![]() | Address | |||
![]() ![]() ![]() |
Reference
(
|
|||
|
Σ | 0..* | Coding |
|
|
Σ |
|
|
|
|
Σ | 0..1 | Illness, injury or treatable condition date | |
![]() ![]() ![]() ![]() | date | |||
|
|
|||
|
Σ | 0..1 | Coding |
|
|
Σ |
|
|
|
|
Σ | 0..1 |
Period
|
Period in hospital |
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 0..1 | Responsible practitioner | |
![]() ![]() ![]() ![]() | Identifier | |||
|
Reference ( Practitioner ) | |||
![]() ![]() ![]() |
Σ | 0..1 | Supervising Practitioner | |
![]() ![]() ![]() ![]() | Identifier | |||
![]() ![]() ![]() ![]() | Reference ( Practitioner ) | |||
|
|
0..1 | Coding |
Type, classification or Specialization
Example Provider Qualification Codes ( Example ) |
|
Σ | 0..* | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ |
|
|
Example Service Modifier Codes ( Example ) |
|
Σ |
|
|
Modifier type Codes ( Example ) |
|
Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
![]() ![]() ![]() |
Σ | 0..1 | Date or dates of Service | |
![]() ![]() ![]() ![]() |
|
|||
|
|
|||
|
Σ | 0..1 |
|
Example Service Place Codes ( Example ) |
|
Σ | 0..1 |
|
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 |
|
|
|
Σ | 0..1 |
decimal
|
Difficulty scaling factor |
|
Σ | 0..1 |
|
|
| Σ | 0..* |
Reference
(
|
Unique Device Identifier |
|
Σ |
|
Coding |
|
|
Σ | 0..* | Coding |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() ![]() ![]() | Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | Money |
|
|
Σ |
|
|
Unique Device Identifier |
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | positiveInt |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 1..1 | Coding |
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding |
Program specific reason for item inclusion
Example Program Reason Codes ( Example ) |
|
Σ | 0..1 | SimpleQuantity |
|
|
Σ | 0..1 | Money |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | decimal |
|
|
Σ | 0..1 | Money |
|
|
Σ |
|
|
Unique Device Identifier |
|
Σ | 0..1 | BackboneElement |
|
|
Σ | 0..1 | boolean |
|
|
Σ | 0..1 | date |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | Money | Total claim cost |
![]() ![]() |
Σ | 0..* | Coding |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | Coding |
|
|
Σ | 0..1 | Coding |
|
|
Σ | 0..1 | date |
|
Documentation for this format
|
||||
XML
Template
XML Template
<Claim xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< <</identifier><type value="[code]"/><!-- 1..1 institutional | oral | pharmacy | professional | vision --> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --><</target> <</provider> <</organization><billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <target[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></target[x]> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible provider --></provider[x]> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></organization[x]> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --><</priority><priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve><</enterer> <</facility> <</prescription> <</originalPrescription> < <</type> <</provider> <</organization> <</person><enterer[x]><!-- 0..1 Identifier|Reference(Practitioner) Author --></enterer[x]> <facility[x]><!-- 0..1 Identifier|Reference(Location) Servicing Facility --></facility[x]> <related> <!-- 0..* Related Claims which may be revelant to processing this claimn --> <claim[x]><!-- 0..1 Identifier|Reference(Claim) Reference to the related claim --></claim[x]> <relationship><!-- 0..1 Coding How the reference claim is related --></relationship> <reference><!-- 0..1 Identifier Related file or case reference --></reference> </related> <prescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder| VisionPrescription) Prescription --></prescription[x]> <originalPrescription[x]><!-- 0..1 Identifier|Reference(MedicationOrder) Original Prescription --></originalPrescription[x]> <payee> <!-- 0..1 Party to be paid any benefits payable --> <type><!-- 1..1 Coding Type of party: Subscriber, Provider, other --></type> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee><</referral><referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <occurrenceCode><!-- 0..* Coding Occurrence Codes --></occurrenceCode> <occurenceSpanCode><!-- 0..* Coding Occurrence Span Codes --></occurenceSpanCode> <valueCode><!-- 0..* Coding Value Codes --></valueCode> <diagnosis> <!-- 0..* Diagnosis --><<sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis><</condition> <</patient><procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <specialCondition><!-- 0..* Coding List of special Conditions --></specialCondition> <patient[x]><!-- 1..1 Identifier|Reference(Patient) The subject of the Products and Services --></patient[x]> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance identifier -->< <</coverage><focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage[x]><!-- 1..1 Identifier|Reference(Coverage) Insurance information --></coverage[x]> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --><</relationship><preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage><</exception> < < <</accidentType><accidentDate value="[date]"/><!-- 0..1 When the accident occurred --> <accidentType><!-- 0..1 Coding The nature of the accident --></accidentType> <accidentLocation[x]><!-- 0..1 Address|Reference(Location) Accident Place --></accidentLocation[x]> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <onset> <!-- 0..* Condition related Onset related dates and codes --> <time[x]><!-- 0..1 date|Period Illness, injury or treatable condition date --></time[x]> <type><!-- 0..1 Coding Onset of what --></type> </onset> <employmentImpacted><!-- 0..1 Period Period unable to work --></employmentImpacted> <hospitalization><!-- 0..1 Period Period in hospital --></hospitalization> <item> <!-- 0..* Goods and Services --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type> <</provider> <<type><!-- 1..1 Coding Group or type of product or service --></type> <provider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></provider[x]> <supervisor[x]><!-- 0..1 Identifier|Reference(Practitioner) Supervising Practitioner --></supervisor[x]> <providerQualification><!-- 0..1 Coding Type, classification or Specialization --></providerQualification> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <service><!-- 1..1 Coding Item Code --></service><<serviceModifier><!-- 0..* Coding Service/Product modifiers --></serviceModifier> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <serviced[x]><!-- 0..1 date|Period Date or dates of Service --></serviced[x]> <place><!-- 0..1 Coding Place of service --></place> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi> <</bodySite> <</subSite> <</modifier><net><!-- 0..1 Quantity(Money) Total item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subSite><!-- 0..* Coding Service Sub-location --></subSite> <detail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type><type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi><net><!-- 0..1 Quantity(Money) Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --><</type> <</service><type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity><</unitPrice><unitPrice><!-- 0..1 Quantity(Money) Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --><</net> <</udi><net><!-- 0..1 Quantity(Money) Net additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> </subDetail> </detail> <prosthesis> <!-- 0..1 Prosthetic details --> <initial value="[boolean]"/><!-- 0..1 Is this the initial service --> <priorDate value="[date]"/><!-- 0..1 Initial service Date --> <priorMaterial><!-- 0..1 Coding Prosthetic Material --></priorMaterial> </prosthesis> </item><</additionalMaterials><total><!-- 0..1 Quantity(Money) Total claim cost --></total> <additionalMaterial><!-- 0..* Coding Additional supporting materials and documents --></additionalMaterial> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth><</reason> <<reason><!-- 0..1 Coding Indicates whether it was extracted or other reason --></reason> <extractionDate value="[date]"/><!-- 0..1 Date tooth was extracted if known --> </missingTeeth> </Claim>
JSON
Template
JSON Template
{
"resourceType" : "Claim",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"type" : "<code>", // R! institutional | oral | pharmacy | professional | vision
"subType" : [{ Coding }], // Finer grained claim type information
"identifier" : [{ Identifier }], // Claim number
"ruleset" : { Coding }, // Current specification followed
"originalRuleset" : { Coding }, // Original specification followed
"created" : "<dateTime>", // Creation date
"
"
"
"billablePeriod" : { Period }, // Period for charge submission
// target[x]: Insurer. One of these 2:
"targetIdentifier" : { Identifier },
"targetReference" : { Reference(Organization) },
// provider[x]: Responsible provider. One of these 2:
"providerIdentifier" : { Identifier },
"providerReference" : { Reference(Practitioner) },
// organization[x]: Responsible organization. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
"use" : "<code>", // complete | proposed | exploratory | other
"
"priority" : { Coding }, // Desired processing priority
"fundsReserve" : { Coding }, // Funds requested to be reserved
"
"
"
"
"
"
"
"
"
// enterer[x]: Author. One of these 2:
"entererIdentifier" : { Identifier },
"entererReference" : { Reference(Practitioner) },
// facility[x]: Servicing Facility. One of these 2:
"facilityIdentifier" : { Identifier },
"facilityReference" : { Reference(Location) },
"related" : [{ // Related Claims which may be revelant to processing this claimn
// claim[x]: Reference to the related claim. One of these 2:
"claimIdentifier" : { Identifier },
"claimReference" : { Reference(Claim) },
"relationship" : { Coding }, // How the reference claim is related
"reference" : { Identifier } // Related file or case reference
}],
// prescription[x]: Prescription. One of these 2:
"prescriptionIdentifier" : { Identifier },
"prescriptionReference" : { Reference(MedicationOrder|VisionPrescription) },
// originalPrescription[x]: Original Prescription. One of these 2:
"originalPrescriptionIdentifier" : { Identifier },
"originalPrescriptionReference" : { Reference(MedicationOrder) },
"payee" : { // Party to be paid any benefits payable
"type" : { Coding }, // R! Type of party: Subscriber, Provider, other
// party[x]: Party to receive the payable. One of these 2:
"partyIdentifier" : { Identifier }
"partyReference" : { Reference(Practitioner|Organization|Patient|RelatedPerson) }
},
"
// referral[x]: Treatment Referral. One of these 2:
"referralIdentifier" : { Identifier },
"referralReference" : { Reference(ReferralRequest) },
"occurrenceCode" : [{ Coding }], // Occurrence Codes
"occurenceSpanCode" : [{ Coding }], // Occurrence Span Codes
"valueCode" : [{ Coding }], // Value Codes
"diagnosis" : [{ // Diagnosis
"
"sequence" : "<positiveInt>", // R! Number to covey order of diagnosis
"diagnosis" : { Coding } // R! Patient's list of diagnosis
}],
"
"
"procedure" : [{ // Procedures performed
"sequence" : "<positiveInt>", // R! Procedure sequence for reference
"date" : "<dateTime>", // When the procedure was performed
// procedure[x]: Patient's list of procedures performed. One of these 2:
"procedureCoding" : { Coding }
"procedureReference" : { Reference(Procedure) }
}],
"specialCondition" : [{ Coding }], // List of special Conditions
// patient[x]: The subject of the Products and Services. One of these 2:
"patientIdentifier" : { Identifier },
"patientReference" : { Reference(Patient) },
"coverage" : [{ // Insurance or medical plan
"sequence" : "<positiveInt>", // R! Service instance identifier
"
"
"focal" : <boolean>, // R! Is the focal Coverage
// coverage[x]: Insurance information. One of these 2:
"coverageIdentifier" : { Identifier },
"coverageReference" : { Reference(Coverage) },
"businessArrangement" : "<string>", // Business agreement
"
"preAuthRef" : ["<string>"], // Pre-Authorization/Determination Reference
"claimResponse" : { Reference(ClaimResponse) }, // Adjudication results
"originalRuleset" : { Coding } // Original version
}],
"
"
"
"
"accidentDate" : "<date>", // When the accident occurred
"accidentType" : { Coding }, // The nature of the accident
// accidentLocation[x]: Accident Place. One of these 2:
"accidentLocationAddress" : { Address },
"accidentLocationReference" : { Reference(Location) },
"interventionException" : [{ Coding }], // Intervention and exception code (Pharma)
"onset" : [{ // Condition related Onset related dates and codes
// time[x]: Illness, injury or treatable condition date. One of these 2:
"timeDate" : "<date>",
"timePeriod" : { Period },
"type" : { Coding } // Onset of what
}],
"employmentImpacted" : { Period }, // Period unable to work
"hospitalization" : { Period }, // Period in hospital
"item" : [{ // Goods and Services
"sequence" : "<positiveInt>", // R! Service instance
"
"
"
"type" : { Coding }, // R! Group or type of product or service
// provider[x]: Responsible practitioner. One of these 2:
"providerIdentifier" : { Identifier },
"providerReference" : { Reference(Practitioner) },
// supervisor[x]: Supervising Practitioner. One of these 2:
"supervisorIdentifier" : { Identifier },
"supervisorReference" : { Reference(Practitioner) },
"providerQualification" : { Coding }, // Type, classification or Specialization
"diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses
"service" : { Coding }, // R! Item Code
"
"serviceModifier" : [{ Coding }], // Service/Product modifiers
"modifier" : [{ Coding }], // Service/Product billing modifiers
"programCode" : [{ Coding }], // Program specific reason for item inclusion
// serviced[x]: Date or dates of Service. One of these 2:
"servicedDate" : "<date>",
"servicedPeriod" : { Period },
"place" : { Coding }, // Place of service
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"
"
"
"net" : { Quantity(Money) }, // Total item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"bodySite" : { Coding }, // Service Location
"subSite" : [{ Coding }], // Service Sub-location
"detail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"
"type" : { Coding }, // R! Group or type of product or service
"service" : { Coding }, // R! Additional item codes
"programCode" : [{ Coding }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"net" : { Quantity(Money) }, // Total additional item cost
"udi" : [{ Reference(Device) }], // Unique Device Identifier
"subDetail" : [{ // Additional items
"sequence" : "<positiveInt>", // R! Service instance
"
"
"type" : { Coding }, // R! Type of product or service
"service" : { Coding }, // R! Additional item codes
"programCode" : [{ Coding }], // Program specific reason for item inclusion
"quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services
"
"unitPrice" : { Quantity(Money) }, // Fee, charge or cost per point
"factor" : <decimal>, // Price scaling factor
"points" : <decimal>, // Difficulty scaling factor
"
"
"net" : { Quantity(Money) }, // Net additional item cost
"udi" : [{ Reference(Device) }] // Unique Device Identifier
}]
}],
"prosthesis" : { // Prosthetic details
"initial" : <boolean>, // Is this the initial service
"priorDate" : "<date>", // Initial service Date
"priorMaterial" : { Coding } // Prosthetic Material
}
}],
"
"total" : { Quantity(Money) }, // Total claim cost
"additionalMaterial" : [{ Coding }], // Additional supporting materials and documents
"missingTeeth" : [{ // Only if type = oral
"tooth" : { Coding }, // R! Tooth Code
"
"
"reason" : { Coding }, // Indicates whether it was extracted or other reason
"extractionDate" : "<date>" // Date tooth was extracted if known
}]
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | ClaimType |
| Claim.subType | A more granulat claim typecode | Example | Example Claim SubType Codes |
|
Claim.ruleset
Claim.originalRuleset |
|
Example |
|
|
|
|
Required | Use |
|
|
|
Example |
|
|
|
|
Example |
|
| Claim.related.relationship | Relationship of this claim to a related Claim | Example | Example Related Claim Relationship Codes |
|
|
|
Example |
|
| Claim.occurrenceCode |
|
Example |
|
| Claim.occurenceSpanCode |
|
Example |
|
| Claim.valueCode |
|
Example |
|
| Claim.diagnosis.diagnosis | ICD10 Diagnostic codes | Example |
|
| Claim.procedure.procedure[x] | ICD10 Procedure codes | Example |
|
| Claim.specialCondition | Patient conditions and symptoms | Example | Conditions Codes |
|
|
|
Required | ActIncidentCode |
|
|
|
Example |
|
| Claim.onset.type | Condition related start, end and period codes | Example | Example Onset Type (Reason) Codes |
|
Claim.item.type
Claim.item.detail.type |
|
Required |
|
| Claim.item.providerQualification | Provider professional qualifications | Example | Example Provider Qualification Codes |
|
Claim.item.service
Claim.item.detail.service |
|
Example |
|
| Claim.item.serviceModifier |
|
Example |
|
| Claim.item.modifier |
|
Example |
|
|
Claim.item.programCode
Claim.item.detail.programCode Claim.item.detail.subDetail.programCode |
|
Example |
|
| Claim.item.place |
Example
|
| |
| Claim.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example |
|
| Claim.item.subSite | The code for the tooth surface and surface combinations | Example | Surface Codes |
|
|
|
Example |
|
|
|
|
Example |
|
|
|
|
Example |
|
|
|
|
Example |
|
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
|
| date | The creation date for the Claim | Claim.created |
| facilityidentifier | token |
| Claim.facilityIdentifier |
| facilityreference | reference | Facility responsible for the goods and services |
Claim.facilityReference
( Location ) |
|
identifier
|
token | The primary identifier of the financial resource | Claim.identifier |
|
| token | The reference to the providing organization | Claim.organizationIdentifier |
| organizationreference | reference |
|
( Organization ) |
| patientidentifier | token | Patient receiving the services | Claim.patientIdentifier |
| patientreference | reference | Patient receiving the services |
Claim.patientReference
( Patient ) |
| priority | token |
|
Claim.priority |
|
| token | Provider responsible for the Claim | Claim.providerIdentifier |
| providerreference | reference |
|
( Practitioner ) |
|
|
token |
|
|
| targetreference |
reference
|
The target payor/insurer for the Claim |
Claim.targetReference
( Organization |
| use | token | The kind of financial resource | Claim.use |