This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Financial Management Work Group | Maturity Level: 1 | Compartments: Patient, Practitioner |
A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
The Claim is used by providers and payors, insurers, to exchange the financial information, and supporting clinical information, regarding the provision of healthcare services with payors an firms which provide data analytics. The primary uses of this resource is to support eClaims, the exchange of proposed or actual services to benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
The Claim is intended to support:
The Claim also supports:
This resource is referenced by ClaimResponse and ExplanationOfBenefit
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | DomainResource | Claim, Pre-determination or Pre-authorization | ||
identifier | 0..* | Identifier | Claim number | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error ClaimStatus (Required) |
type | 1..1 | Coding | Type or discipline Example Claim Type Codes (Required) | |
subType | 0..* | Coding | Finer grained claim type information Example Claim SubType Codes (Example) | |
ruleset | 0..1 | Coding | Current specification followed Ruleset Codes (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset Codes (Example) | |
created | 0..1 | dateTime | Creation date | |
billablePeriod | 0..1 | Period | Period for charge submission | |
insurer[x] | 0..1 | Target | ||
insurerIdentifier | Identifier | |||
insurerReference | Reference(Organization) | |||
provider[x] | 0..1 | Responsible provider | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner) | |||
organization[x] | 0..1 | Responsible organization | ||
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
priority | 0..1 | Coding | Desired processing priority Priority Codes (Example) | |
fundsReserve | 0..1 | Coding | Funds requested to be reserved Funds Reservation Codes (Example) | |
enterer[x] | 0..1 | Author | ||
entererIdentifier | Identifier | |||
entererReference | Reference(Practitioner) | |||
facility[x] | 0..1 | Servicing Facility | ||
facilityIdentifier | Identifier | |||
facilityReference | Reference(Location) | |||
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claimn | |
claim[x] | 0..1 | Reference to the related claim | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
relationship | 0..1 | Coding | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription[x] | 0..1 | Prescription | ||
prescriptionIdentifier | Identifier | |||
prescriptionReference | Reference(MedicationOrder | VisionPrescription) | |||
originalPrescription[x] | 0..1 | Original Prescription | ||
originalPrescriptionIdentifier | Identifier | |||
originalPrescriptionReference | Reference(MedicationOrder) | |||
payee | 0..1 | BackboneElement | Party to be paid any benefits payable | |
type | 1..1 | Coding | Type of party: Subscriber, Provider, other Payee Type Codes (Example) | |
resourceType | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Example) | |
party[x] | 0..1 | Party to receive the payable | ||
partyIdentifier | Identifier | |||
partyReference | Reference(Practitioner | Organization | Patient | RelatedPerson) | |||
referral[x] | 0..1 | Treatment Referral | ||
referralIdentifier | Identifier | |||
referralReference | Reference(ReferralRequest) | |||
information | 0..* | BackboneElement | ||
category | 1..1 | Coding | Category of information Claim Information Category Codes (Example) | |
code | 0..1 | Coding | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data | ||
valueString | string | |||
valueQuantity | Quantity | |||
diagnosis | 0..* | BackboneElement | Diagnosis | |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis | 1..1 | Coding | Patient's diagnosis ICD-10 Codes (Example) | |
type | 0..* | Coding | Type of Diagnosis Example Diagnosis Type Codes (Example) | |
drg | 0..1 | Coding | Diagnosis Related Group Example Diagnosis Related Group Codes (Example) | |
procedure | 0..* | BackboneElement | Procedures performed | |
sequence | 1..1 | positiveInt | Procedure sequence for reference | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Patient's list of procedures performed ICD-10 Procedure Codes (Example) | ||
procedureCoding | Coding | |||
procedureReference | Reference(Procedure) | |||
patient[x] | 1..1 | The subject of the Products and Services | ||
patientIdentifier | Identifier | |||
patientReference | Reference(Patient) | |||
coverage | 0..* | BackboneElement | Insurance or medical plan | |
sequence | 1..1 | positiveInt | Service instance identifier | |
focal | 1..1 | boolean | Is the focal Coverage | |
coverage[x] | 1..1 | Insurance information | ||
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
businessArrangement | 0..1 | string | Business agreement | |
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
originalRuleset | 0..1 | Coding | Original version Ruleset Codes (Example) | |
accident | 0..1 | BackboneElement | ||
date | 1..1 | date | When the accident occurred see information codes see information codes | |
type | 0..1 | Coding | The nature of the accident ActIncidentCode (Required) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
employmentImpacted | 0..1 | Period | Period unable to work | |
hospitalization | 0..1 | Period | Period in hospital | |
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeam | 0..* | BackboneElement | ||
provider[x] | 1..1 | Provider individual or organization | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner | Organization) | |||
responsible | 0..1 | boolean | Billing provider | |
role | 0..1 | Coding | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | Coding | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosisLinkId | 0..* | positiveInt | Applicable diagnoses | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of Service | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service Example Service Place Codes (Example) | ||
locationCoding | Coding | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | Coding | Service Location Oral Site Codes (Example) | |
subSite | 0..* | Coding | Service Sub-location Surface Codes (Example) | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
prosthesis | 0..1 | BackboneElement | Prosthetic details | |
initial | 0..1 | boolean | Is this the initial service | |
priorDate | 0..1 | date | Initial service Date | |
priorMaterial | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) | |
total | 0..1 | Money | Total claim cost | |
missingTeeth | 0..* | BackboneElement | Only if type = oral | |
tooth | 1..1 | Coding | Tooth Code Teeth Codes (Example) | |
reason | 0..1 | Coding | Indicates whether it was extracted or other reason Missing Tooth Reason Codes (Example) | |
extractionDate | 0..1 | date | Date tooth was extracted if known | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Claim number --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <type><!-- 1..1 Coding Type or discipline --></type> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <insurer[x]><!-- 0..1 Identifier|Reference(Organization) Target --></insurer[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><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <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> <resourceType><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resourceType> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee> <referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <information> <!-- 0..* --> <category><!-- 1..1 Coding Category of information --></category> <code><!-- 0..1 Coding Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 string|Quantity Additional Data --></value[x]> </information> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's diagnosis --></diagnosis> <type><!-- 0..* Coding Type of Diagnosis --></type> <drg><!-- 0..1 Coding Diagnosis Related Group --></drg> </diagnosis> <procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <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 --> <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 --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <accident> <date value="[date]"/><!-- 1..1 When the accident occurred see information codes see information codes --> <type><!-- 0..1 Coding The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <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 --> <careTeam> <!-- 0..* --> <provider[x]><!-- 1..1 Identifier|Reference(Practitioner|Organization) Provider individual or organization --></provider[x]> <responsible value="[boolean]"/><!-- 0..1 Billing provider --> <role><!-- 0..1 Coding Role on the team --></role> <qualification><!-- 0..1 Coding Type, classification or Specialization --></qualification> </careTeam> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <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]> <location[x]><!-- 0..1 Coding|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 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 --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 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> <total><!-- 0..1 Money Total claim cost --></total> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <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
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Claim number "status" : "<code>", // R! active | cancelled | draft | entered-in-error "type" : { Coding }, // R! Type or discipline "subType" : [{ Coding }], // Finer grained claim type information "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission // insurer[x]: Target. One of these 2: "insurerIdentifier" : { Identifier }, "insurerReference" : { 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 "resourceType" : { Coding }, // organization | patient | practitioner | relatedperson // 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) }, "information" : [{ // "category" : { Coding }, // R! Category of information "code" : { Coding }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data. One of these 2: "valueString" : "<string>" "valueQuantity" : { Quantity } }], "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Number to covey order of diagnosis "diagnosis" : { Coding }, // R! Patient's diagnosis "type" : [{ Coding }], // Type of Diagnosis "drg" : { Coding } // Diagnosis Related Group }], "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) } }], // 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 }], "accident" : { // "date" : "<date>", // R! When the accident occurred see information codes see information codes "type" : { Coding }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeam" : [{ // // provider[x]: Provider individual or organization. One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner|Organization) }, "responsible" : <boolean>, // Billing provider "role" : { Coding }, // Role on the team "qualification" : { Coding } // Type, classification or Specialization }], "diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "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 }, // location[x]: Place of service. One of these 3: "locationCoding" : { Coding }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { 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 "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { 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" : { Money }, // Total claim cost "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 }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Claim.identifier [ Identifier ], ... ; # 0..* Claim number fhir:Claim.status [ code ]; # 1..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ Coding ]; # 1..1 Type or discipline fhir:Claim.subType [ Coding ], ... ; # 0..* Finer grained claim type information fhir:Claim.ruleset [ Coding ]; # 0..1 Current specification followed fhir:Claim.originalRuleset [ Coding ]; # 0..1 Original specification followed fhir:Claim.created [ dateTime ]; # 0..1 Creation date fhir:Claim.billablePeriod [ Period ]; # 0..1 Period for charge submission # Claim.insurer[x] : 0..1 Target. One of these 2 fhir:Claim.insurerIdentifier [ Identifier ] fhir:Claim.insurerReference [ Reference(Organization) ] # Claim.provider[x] : 0..1 Responsible provider. One of these 2 fhir:Claim.providerIdentifier [ Identifier ] fhir:Claim.providerReference [ Reference(Practitioner) ] # Claim.organization[x] : 0..1 Responsible organization. One of these 2 fhir:Claim.organizationIdentifier [ Identifier ] fhir:Claim.organizationReference [ Reference(Organization) ] fhir:Claim.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:Claim.priority [ Coding ]; # 0..1 Desired processing priority fhir:Claim.fundsReserve [ Coding ]; # 0..1 Funds requested to be reserved # Claim.enterer[x] : 0..1 Author. One of these 2 fhir:Claim.entererIdentifier [ Identifier ] fhir:Claim.entererReference [ Reference(Practitioner) ] # Claim.facility[x] : 0..1 Servicing Facility. One of these 2 fhir:Claim.facilityIdentifier [ Identifier ] fhir:Claim.facilityReference [ Reference(Location) ] fhir:Claim.related [ # 0..* Related Claims which may be revelant to processing this claimn # Claim.related.claim[x] : 0..1 Reference to the related claim. One of these 2 fhir:Claim.related.claimIdentifier [ Identifier ] fhir:Claim.related.claimReference [ Reference(Claim) ] fhir:Claim.related.relationship [ Coding ]; # 0..1 How the reference claim is related fhir:Claim.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; # Claim.prescription[x] : 0..1 Prescription. One of these 2 fhir:Claim.prescriptionIdentifier [ Identifier ] fhir:Claim.prescriptionReference [ Reference(MedicationOrder|VisionPrescription) ] # Claim.originalPrescription[x] : 0..1 Original Prescription. One of these 2 fhir:Claim.originalPrescriptionIdentifier [ Identifier ] fhir:Claim.originalPrescriptionReference [ Reference(MedicationOrder) ] fhir:Claim.payee [ # 0..1 Party to be paid any benefits payable fhir:Claim.payee.type [ Coding ]; # 1..1 Type of party: Subscriber, Provider, other fhir:Claim.payee.resourceType [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson # Claim.payee.party[x] : 0..1 Party to receive the payable. One of these 2 fhir:Claim.payee.partyIdentifier [ Identifier ] fhir:Claim.payee.partyReference [ Reference(Practitioner|Organization|Patient|RelatedPerson) ] ]; # Claim.referral[x] : 0..1 Treatment Referral. One of these 2 fhir:Claim.referralIdentifier [ Identifier ] fhir:Claim.referralReference [ Reference(ReferralRequest) ] fhir:Claim.information [ # 0..* fhir:Claim.information.category [ Coding ]; # 1..1 Category of information fhir:Claim.information.code [ Coding ]; # 0..1 Type of information # Claim.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.information.timingDate [ date ] fhir:Claim.information.timingPeriod [ Period ] # Claim.information.value[x] : 0..1 Additional Data. One of these 2 fhir:Claim.information.valueString [ string ] fhir:Claim.information.valueQuantity [ Quantity ] ], ...; fhir:Claim.diagnosis [ # 0..* Diagnosis fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Number to covey order of diagnosis fhir:Claim.diagnosis.diagnosis [ Coding ]; # 1..1 Patient's diagnosis fhir:Claim.diagnosis.type [ Coding ], ... ; # 0..* Type of Diagnosis fhir:Claim.diagnosis.drg [ Coding ]; # 0..1 Diagnosis Related Group ], ...; fhir:Claim.procedure [ # 0..* Procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:Claim.procedure.procedureCoding [ Coding ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] ], ...; # Claim.patient[x] : 1..1 The subject of the Products and Services. One of these 2 fhir:Claim.patientIdentifier [ Identifier ] fhir:Claim.patientReference [ Reference(Patient) ] fhir:Claim.coverage [ # 0..* Insurance or medical plan fhir:Claim.coverage.sequence [ positiveInt ]; # 1..1 Service instance identifier fhir:Claim.coverage.focal [ boolean ]; # 1..1 Is the focal Coverage # Claim.coverage.coverage[x] : 1..1 Insurance information. One of these 2 fhir:Claim.coverage.coverageIdentifier [ Identifier ] fhir:Claim.coverage.coverageReference [ Reference(Coverage) ] fhir:Claim.coverage.businessArrangement [ string ]; # 0..1 Business agreement fhir:Claim.coverage.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference fhir:Claim.coverage.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results fhir:Claim.coverage.originalRuleset [ Coding ]; # 0..1 Original version ], ...; fhir:Claim.accident [ # 0..1 fhir:Claim.accident.date [ date ]; # 1..1 When the accident occurred see information codes see information codes fhir:Claim.accident.type [ Coding ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ]; fhir:Claim.employmentImpacted [ Period ]; # 0..1 Period unable to work fhir:Claim.hospitalization [ Period ]; # 0..1 Period in hospital fhir:Claim.item [ # 0..* Goods and Services fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.careTeam [ # 0..* # Claim.item.careTeam.provider[x] : 1..1 Provider individual or organization. One of these 2 fhir:Claim.item.careTeam.providerIdentifier [ Identifier ] fhir:Claim.item.careTeam.providerReference [ Reference(Practitioner|Organization) ] fhir:Claim.item.careTeam.responsible [ boolean ]; # 0..1 Billing provider fhir:Claim.item.careTeam.role [ Coding ]; # 0..1 Role on the team fhir:Claim.item.careTeam.qualification [ Coding ]; # 0..1 Type, classification or Specialization ], ...; fhir:Claim.item.diagnosisLinkId [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:Claim.item.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion # Claim.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service. One of these 3 fhir:Claim.item.locationCoding [ Coding ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] fhir:Claim.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.bodySite [ Coding ]; # 0..1 Service Location fhir:Claim.item.subSite [ Coding ], ... ; # 0..* Service Sub-location fhir:Claim.item.detail [ # 0..* Additional items fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.detail.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion fhir:Claim.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.detail.subDetail [ # 0..* Additional items fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.subDetail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.detail.subDetail.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.detail.subDetail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion fhir:Claim.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Net additional item cost fhir:Claim.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier ], ...; ], ...; fhir:Claim.item.prosthesis [ # 0..1 Prosthetic details fhir:Claim.item.prosthesis.initial [ boolean ]; # 0..1 Is this the initial service fhir:Claim.item.prosthesis.priorDate [ date ]; # 0..1 Initial service Date fhir:Claim.item.prosthesis.priorMaterial [ Coding ]; # 0..1 Prosthetic Material ]; ], ...; fhir:Claim.total [ Money ]; # 0..1 Total claim cost fhir:Claim.missingTeeth [ # 0..* Only if type = oral fhir:Claim.missingTeeth.tooth [ Coding ]; # 1..1 Tooth Code fhir:Claim.missingTeeth.reason [ Coding ]; # 0..1 Indicates whether it was extracted or other reason fhir:Claim.missingTeeth.extractionDate [ date ]; # 0..1 Date tooth was extracted if known ], ...; ]
Changes since DSTU2
Claim | |
Claim.status | added |
Claim.type |
Type changed from code to Coding Change value set from http://hl7.org/fhir/ValueSet/claim-type-link to http://hl7.org/fhir/ValueSet/claim-type |
Claim.subType | added |
Claim.billablePeriod | added |
Claim.insurer[x] | added |
Claim.provider[x] |
Renamed from provider to provider[x] Add Identifier |
Claim.organization[x] |
Renamed from organization to organization[x] Add Identifier |
Claim.use | Change value set from http://hl7.org/fhir/ValueSet/claim-use-link to http://hl7.org/fhir/ValueSet/claim-use |
Claim.enterer[x] |
Renamed from enterer to enterer[x] Add Identifier |
Claim.facility[x] |
Renamed from facility to facility[x] Add Identifier |
Claim.related | added |
Claim.related.claim[x] | added |
Claim.related.relationship | added |
Claim.related.reference | added |
Claim.prescription[x] |
Renamed from prescription to prescription[x] Add Identifier |
Claim.originalPrescription[x] |
Renamed from originalPrescription to originalPrescription[x] Add Identifier |
Claim.payee.type | Min Cardinality changed from 0 to 1 |
Claim.payee.resourceType | added |
Claim.payee.party[x] | added |
Claim.referral[x] |
Renamed from referral to referral[x] Add Identifier |
Claim.information | added |
Claim.information.category | added |
Claim.information.code | added |
Claim.information.timing[x] | added |
Claim.information.value[x] | added |
Claim.diagnosis.type | added |
Claim.diagnosis.drg | added |
Claim.procedure | added |
Claim.procedure.sequence | added |
Claim.procedure.date | added |
Claim.procedure.procedure[x] | added |
Claim.patient[x] |
Renamed from patient to patient[x] Add Identifier |
Claim.coverage.coverage[x] |
Renamed from coverage to coverage[x] Add Identifier |
Claim.accident | Type changed from date to BackboneElement |
Claim.accident.date | added |
Claim.accident.type | added |
Claim.accident.location[x] | added |
Claim.employmentImpacted | added |
Claim.hospitalization | added |
Claim.item.careTeam | added |
Claim.item.careTeam.provider[x] | added |
Claim.item.careTeam.responsible | added |
Claim.item.careTeam.role | added |
Claim.item.careTeam.qualification | added |
Claim.item.revenue | added |
Claim.item.category | added |
Claim.item.service | Min Cardinality changed from 1 to 0 |
Claim.item.programCode | added |
Claim.item.serviced[x] | added |
Claim.item.location[x] | added |
Claim.item.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.item.detail.revenue | added |
Claim.item.detail.category | added |
Claim.item.detail.service | Min Cardinality changed from 1 to 0 |
Claim.item.detail.modifier | added |
Claim.item.detail.programCode | added |
Claim.item.detail.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.item.detail.subDetail.revenue | added |
Claim.item.detail.subDetail.category | added |
Claim.item.detail.subDetail.service | Min Cardinality changed from 1 to 0 |
Claim.item.detail.subDetail.modifier | added |
Claim.item.detail.subDetail.programCode | added |
Claim.item.detail.subDetail.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.subDetail.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.subDetail.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.total | added |
Claim.target | deleted |
Claim.payee.provider | deleted |
Claim.payee.organization | deleted |
Claim.payee.person | deleted |
Claim.condition | deleted |
Claim.coverage.relationship | deleted |
Claim.exception | deleted |
Claim.school | deleted |
Claim.accidentType | deleted |
Claim.interventionException | deleted |
Claim.item.type | deleted |
Claim.item.provider | deleted |
Claim.item.serviceDate | deleted |
Claim.item.detail.type | deleted |
Claim.item.detail.subDetail.type | deleted |
Claim.additionalMaterials | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | DomainResource | Claim, Pre-determination or Pre-authorization | ||
identifier | 0..* | Identifier | Claim number | |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error ClaimStatus (Required) |
type | 1..1 | Coding | Type or discipline Example Claim Type Codes (Required) | |
subType | 0..* | Coding | Finer grained claim type information Example Claim SubType Codes (Example) | |
ruleset | 0..1 | Coding | Current specification followed Ruleset Codes (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset Codes (Example) | |
created | 0..1 | dateTime | Creation date | |
billablePeriod | 0..1 | Period | Period for charge submission | |
insurer[x] | 0..1 | Target | ||
insurerIdentifier | Identifier | |||
insurerReference | Reference(Organization) | |||
provider[x] | 0..1 | Responsible provider | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner) | |||
organization[x] | 0..1 | Responsible organization | ||
organizationIdentifier | Identifier | |||
organizationReference | Reference(Organization) | |||
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
priority | 0..1 | Coding | Desired processing priority Priority Codes (Example) | |
fundsReserve | 0..1 | Coding | Funds requested to be reserved Funds Reservation Codes (Example) | |
enterer[x] | 0..1 | Author | ||
entererIdentifier | Identifier | |||
entererReference | Reference(Practitioner) | |||
facility[x] | 0..1 | Servicing Facility | ||
facilityIdentifier | Identifier | |||
facilityReference | Reference(Location) | |||
related | 0..* | BackboneElement | Related Claims which may be revelant to processing this claimn | |
claim[x] | 0..1 | Reference to the related claim | ||
claimIdentifier | Identifier | |||
claimReference | Reference(Claim) | |||
relationship | 0..1 | Coding | How the reference claim is related Example Related Claim Relationship Codes (Example) | |
reference | 0..1 | Identifier | Related file or case reference | |
prescription[x] | 0..1 | Prescription | ||
prescriptionIdentifier | Identifier | |||
prescriptionReference | Reference(MedicationOrder | VisionPrescription) | |||
originalPrescription[x] | 0..1 | Original Prescription | ||
originalPrescriptionIdentifier | Identifier | |||
originalPrescriptionReference | Reference(MedicationOrder) | |||
payee | 0..1 | BackboneElement | Party to be paid any benefits payable | |
type | 1..1 | Coding | Type of party: Subscriber, Provider, other Payee Type Codes (Example) | |
resourceType | 0..1 | Coding | organization | patient | practitioner | relatedperson PayeeResourceType (Example) | |
party[x] | 0..1 | Party to receive the payable | ||
partyIdentifier | Identifier | |||
partyReference | Reference(Practitioner | Organization | Patient | RelatedPerson) | |||
referral[x] | 0..1 | Treatment Referral | ||
referralIdentifier | Identifier | |||
referralReference | Reference(ReferralRequest) | |||
information | 0..* | BackboneElement | ||
category | 1..1 | Coding | Category of information Claim Information Category Codes (Example) | |
code | 0..1 | Coding | Type of information Exception Codes (Example) | |
timing[x] | 0..1 | When it occurred | ||
timingDate | date | |||
timingPeriod | Period | |||
value[x] | 0..1 | Additional Data | ||
valueString | string | |||
valueQuantity | Quantity | |||
diagnosis | 0..* | BackboneElement | Diagnosis | |
sequence | 1..1 | positiveInt | Number to covey order of diagnosis | |
diagnosis | 1..1 | Coding | Patient's diagnosis ICD-10 Codes (Example) | |
type | 0..* | Coding | Type of Diagnosis Example Diagnosis Type Codes (Example) | |
drg | 0..1 | Coding | Diagnosis Related Group Example Diagnosis Related Group Codes (Example) | |
procedure | 0..* | BackboneElement | Procedures performed | |
sequence | 1..1 | positiveInt | Procedure sequence for reference | |
date | 0..1 | dateTime | When the procedure was performed | |
procedure[x] | 1..1 | Patient's list of procedures performed ICD-10 Procedure Codes (Example) | ||
procedureCoding | Coding | |||
procedureReference | Reference(Procedure) | |||
patient[x] | 1..1 | The subject of the Products and Services | ||
patientIdentifier | Identifier | |||
patientReference | Reference(Patient) | |||
coverage | 0..* | BackboneElement | Insurance or medical plan | |
sequence | 1..1 | positiveInt | Service instance identifier | |
focal | 1..1 | boolean | Is the focal Coverage | |
coverage[x] | 1..1 | Insurance information | ||
coverageIdentifier | Identifier | |||
coverageReference | Reference(Coverage) | |||
businessArrangement | 0..1 | string | Business agreement | |
preAuthRef | 0..* | string | Pre-Authorization/Determination Reference | |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
originalRuleset | 0..1 | Coding | Original version Ruleset Codes (Example) | |
accident | 0..1 | BackboneElement | ||
date | 1..1 | date | When the accident occurred see information codes see information codes | |
type | 0..1 | Coding | The nature of the accident ActIncidentCode (Required) | |
location[x] | 0..1 | Accident Place | ||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
employmentImpacted | 0..1 | Period | Period unable to work | |
hospitalization | 0..1 | Period | Period in hospital | |
item | 0..* | BackboneElement | Goods and Services | |
sequence | 1..1 | positiveInt | Service instance | |
careTeam | 0..* | BackboneElement | ||
provider[x] | 1..1 | Provider individual or organization | ||
providerIdentifier | Identifier | |||
providerReference | Reference(Practitioner | Organization) | |||
responsible | 0..1 | boolean | Billing provider | |
role | 0..1 | Coding | Role on the team Claim Care Team Role Codes (Example) | |
qualification | 0..1 | Coding | Type, classification or Specialization Example Provider Qualification Codes (Example) | |
diagnosisLinkId | 0..* | positiveInt | Applicable diagnoses | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
serviced[x] | 0..1 | Date or dates of Service | ||
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | 0..1 | Place of service Example Service Place Codes (Example) | ||
locationCoding | Coding | |||
locationAddress | Address | |||
locationReference | Reference(Location) | |||
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
bodySite | 0..1 | Coding | Service Location Oral Site Codes (Example) | |
subSite | 0..* | Coding | Service Sub-location Surface Codes (Example) | |
detail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
subDetail | 0..* | BackboneElement | Additional items | |
sequence | 1..1 | positiveInt | Service instance | |
revenue | 0..1 | Coding | Revenue or cost center code Example Revenue Center Codes (Example) | |
category | 0..1 | Coding | Type of service or product Benefit SubCategory Codes (Example) | |
service | 0..1 | Coding | Billing Code USCLS Codes (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifier type Codes (Example) | |
programCode | 0..* | Coding | Program specific reason for item inclusion Example Program Reason Codes (Example) | |
quantity | 0..1 | SimpleQuantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..* | Reference(Device) | Unique Device Identifier | |
prosthesis | 0..1 | BackboneElement | Prosthetic details | |
initial | 0..1 | boolean | Is this the initial service | |
priorDate | 0..1 | date | Initial service Date | |
priorMaterial | 0..1 | Coding | Prosthetic Material Oral Prostho Material type Codes (Example) | |
total | 0..1 | Money | Total claim cost | |
missingTeeth | 0..* | BackboneElement | Only if type = oral | |
tooth | 1..1 | Coding | Tooth Code Teeth Codes (Example) | |
reason | 0..1 | Coding | Indicates whether it was extracted or other reason Missing Tooth Reason Codes (Example) | |
extractionDate | 0..1 | date | Date tooth was extracted if known | |
Documentation for this format |
XML Template
<Claim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Claim number --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <type><!-- 1..1 Coding Type or discipline --></type> <subType><!-- 0..* Coding Finer grained claim type information --></subType> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <billablePeriod><!-- 0..1 Period Period for charge submission --></billablePeriod> <insurer[x]><!-- 0..1 Identifier|Reference(Organization) Target --></insurer[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><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <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> <resourceType><!-- 0..1 Coding organization | patient | practitioner | relatedperson --></resourceType> <party[x]><!-- 0..1 Identifier|Reference(Practitioner|Organization|Patient| RelatedPerson) Party to receive the payable --></party[x]> </payee> <referral[x]><!-- 0..1 Identifier|Reference(ReferralRequest) Treatment Referral --></referral[x]> <information> <!-- 0..* --> <category><!-- 1..1 Coding Category of information --></category> <code><!-- 0..1 Coding Type of information --></code> <timing[x]><!-- 0..1 date|Period When it occurred --></timing[x]> <value[x]><!-- 0..1 string|Quantity Additional Data --></value[x]> </information> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[positiveInt]"/><!-- 1..1 Number to covey order of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's diagnosis --></diagnosis> <type><!-- 0..* Coding Type of Diagnosis --></type> <drg><!-- 0..1 Coding Diagnosis Related Group --></drg> </diagnosis> <procedure> <!-- 0..* Procedures performed --> <sequence value="[positiveInt]"/><!-- 1..1 Procedure sequence for reference --> <date value="[dateTime]"/><!-- 0..1 When the procedure was performed --> <procedure[x]><!-- 1..1 Coding|Reference(Procedure) Patient's list of procedures performed --></procedure[x]> </procedure> <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 --> <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 --> <preAuthRef value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <accident> <date value="[date]"/><!-- 1..1 When the accident occurred see information codes see information codes --> <type><!-- 0..1 Coding The nature of the accident --></type> <location[x]><!-- 0..1 Address|Reference(Location) Accident Place --></location[x]> </accident> <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 --> <careTeam> <!-- 0..* --> <provider[x]><!-- 1..1 Identifier|Reference(Practitioner|Organization) Provider individual or organization --></provider[x]> <responsible value="[boolean]"/><!-- 0..1 Billing provider --> <role><!-- 0..1 Coding Role on the team --></role> <qualification><!-- 0..1 Coding Type, classification or Specialization --></qualification> </careTeam> <diagnosisLinkId value="[positiveInt]"/><!-- 0..* Applicable diagnoses --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <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]> <location[x]><!-- 0..1 Coding|Address|Reference(Location) Place of service --></location[x]> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 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 --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..* Reference(Device) Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[positiveInt]"/><!-- 1..1 Service instance --> <revenue><!-- 0..1 Coding Revenue or cost center code --></revenue> <category><!-- 0..1 Coding Type of service or product --></category> <service><!-- 0..1 Coding Billing Code --></service> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <programCode><!-- 0..* Coding Program specific reason for item inclusion --></programCode> <quantity><!-- 0..1 Quantity(SimpleQuantity) Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 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> <total><!-- 0..1 Money Total claim cost --></total> <missingTeeth> <!-- 0..* Only if type = oral --> <tooth><!-- 1..1 Coding Tooth Code --></tooth> <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
{ "resourceType" : "Claim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Claim number "status" : "<code>", // R! active | cancelled | draft | entered-in-error "type" : { Coding }, // R! Type or discipline "subType" : [{ Coding }], // Finer grained claim type information "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "billablePeriod" : { Period }, // Period for charge submission // insurer[x]: Target. One of these 2: "insurerIdentifier" : { Identifier }, "insurerReference" : { 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 "resourceType" : { Coding }, // organization | patient | practitioner | relatedperson // 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) }, "information" : [{ // "category" : { Coding }, // R! Category of information "code" : { Coding }, // Type of information // timing[x]: When it occurred. One of these 2: "timingDate" : "<date>", "timingPeriod" : { Period }, // value[x]: Additional Data. One of these 2: "valueString" : "<string>" "valueQuantity" : { Quantity } }], "diagnosis" : [{ // Diagnosis "sequence" : "<positiveInt>", // R! Number to covey order of diagnosis "diagnosis" : { Coding }, // R! Patient's diagnosis "type" : [{ Coding }], // Type of Diagnosis "drg" : { Coding } // Diagnosis Related Group }], "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) } }], // 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 }], "accident" : { // "date" : "<date>", // R! When the accident occurred see information codes see information codes "type" : { Coding }, // The nature of the accident // location[x]: Accident Place. One of these 2: "locationAddress" : { Address } "locationReference" : { Reference(Location) } }, "employmentImpacted" : { Period }, // Period unable to work "hospitalization" : { Period }, // Period in hospital "item" : [{ // Goods and Services "sequence" : "<positiveInt>", // R! Service instance "careTeam" : [{ // // provider[x]: Provider individual or organization. One of these 2: "providerIdentifier" : { Identifier }, "providerReference" : { Reference(Practitioner|Organization) }, "responsible" : <boolean>, // Billing provider "role" : { Coding }, // Role on the team "qualification" : { Coding } // Type, classification or Specialization }], "diagnosisLinkId" : ["<positiveInt>"], // Applicable diagnoses "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "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 }, // location[x]: Place of service. One of these 3: "locationCoding" : { Coding }, "locationAddress" : { Address }, "locationReference" : { Reference(Location) }, "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { 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 "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total additional item cost "udi" : [{ Reference(Device) }], // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : "<positiveInt>", // R! Service instance "revenue" : { Coding }, // Revenue or cost center code "category" : { Coding }, // Type of service or product "service" : { Coding }, // Billing Code "modifier" : [{ Coding }], // Service/Product billing modifiers "programCode" : [{ Coding }], // Program specific reason for item inclusion "quantity" : { Quantity(SimpleQuantity) }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { 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" : { Money }, // Total claim cost "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 }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Claim; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Claim.identifier [ Identifier ], ... ; # 0..* Claim number fhir:Claim.status [ code ]; # 1..1 active | cancelled | draft | entered-in-error fhir:Claim.type [ Coding ]; # 1..1 Type or discipline fhir:Claim.subType [ Coding ], ... ; # 0..* Finer grained claim type information fhir:Claim.ruleset [ Coding ]; # 0..1 Current specification followed fhir:Claim.originalRuleset [ Coding ]; # 0..1 Original specification followed fhir:Claim.created [ dateTime ]; # 0..1 Creation date fhir:Claim.billablePeriod [ Period ]; # 0..1 Period for charge submission # Claim.insurer[x] : 0..1 Target. One of these 2 fhir:Claim.insurerIdentifier [ Identifier ] fhir:Claim.insurerReference [ Reference(Organization) ] # Claim.provider[x] : 0..1 Responsible provider. One of these 2 fhir:Claim.providerIdentifier [ Identifier ] fhir:Claim.providerReference [ Reference(Practitioner) ] # Claim.organization[x] : 0..1 Responsible organization. One of these 2 fhir:Claim.organizationIdentifier [ Identifier ] fhir:Claim.organizationReference [ Reference(Organization) ] fhir:Claim.use [ code ]; # 0..1 complete | proposed | exploratory | other fhir:Claim.priority [ Coding ]; # 0..1 Desired processing priority fhir:Claim.fundsReserve [ Coding ]; # 0..1 Funds requested to be reserved # Claim.enterer[x] : 0..1 Author. One of these 2 fhir:Claim.entererIdentifier [ Identifier ] fhir:Claim.entererReference [ Reference(Practitioner) ] # Claim.facility[x] : 0..1 Servicing Facility. One of these 2 fhir:Claim.facilityIdentifier [ Identifier ] fhir:Claim.facilityReference [ Reference(Location) ] fhir:Claim.related [ # 0..* Related Claims which may be revelant to processing this claimn # Claim.related.claim[x] : 0..1 Reference to the related claim. One of these 2 fhir:Claim.related.claimIdentifier [ Identifier ] fhir:Claim.related.claimReference [ Reference(Claim) ] fhir:Claim.related.relationship [ Coding ]; # 0..1 How the reference claim is related fhir:Claim.related.reference [ Identifier ]; # 0..1 Related file or case reference ], ...; # Claim.prescription[x] : 0..1 Prescription. One of these 2 fhir:Claim.prescriptionIdentifier [ Identifier ] fhir:Claim.prescriptionReference [ Reference(MedicationOrder|VisionPrescription) ] # Claim.originalPrescription[x] : 0..1 Original Prescription. One of these 2 fhir:Claim.originalPrescriptionIdentifier [ Identifier ] fhir:Claim.originalPrescriptionReference [ Reference(MedicationOrder) ] fhir:Claim.payee [ # 0..1 Party to be paid any benefits payable fhir:Claim.payee.type [ Coding ]; # 1..1 Type of party: Subscriber, Provider, other fhir:Claim.payee.resourceType [ Coding ]; # 0..1 organization | patient | practitioner | relatedperson # Claim.payee.party[x] : 0..1 Party to receive the payable. One of these 2 fhir:Claim.payee.partyIdentifier [ Identifier ] fhir:Claim.payee.partyReference [ Reference(Practitioner|Organization|Patient|RelatedPerson) ] ]; # Claim.referral[x] : 0..1 Treatment Referral. One of these 2 fhir:Claim.referralIdentifier [ Identifier ] fhir:Claim.referralReference [ Reference(ReferralRequest) ] fhir:Claim.information [ # 0..* fhir:Claim.information.category [ Coding ]; # 1..1 Category of information fhir:Claim.information.code [ Coding ]; # 0..1 Type of information # Claim.information.timing[x] : 0..1 When it occurred. One of these 2 fhir:Claim.information.timingDate [ date ] fhir:Claim.information.timingPeriod [ Period ] # Claim.information.value[x] : 0..1 Additional Data. One of these 2 fhir:Claim.information.valueString [ string ] fhir:Claim.information.valueQuantity [ Quantity ] ], ...; fhir:Claim.diagnosis [ # 0..* Diagnosis fhir:Claim.diagnosis.sequence [ positiveInt ]; # 1..1 Number to covey order of diagnosis fhir:Claim.diagnosis.diagnosis [ Coding ]; # 1..1 Patient's diagnosis fhir:Claim.diagnosis.type [ Coding ], ... ; # 0..* Type of Diagnosis fhir:Claim.diagnosis.drg [ Coding ]; # 0..1 Diagnosis Related Group ], ...; fhir:Claim.procedure [ # 0..* Procedures performed fhir:Claim.procedure.sequence [ positiveInt ]; # 1..1 Procedure sequence for reference fhir:Claim.procedure.date [ dateTime ]; # 0..1 When the procedure was performed # Claim.procedure.procedure[x] : 1..1 Patient's list of procedures performed. One of these 2 fhir:Claim.procedure.procedureCoding [ Coding ] fhir:Claim.procedure.procedureReference [ Reference(Procedure) ] ], ...; # Claim.patient[x] : 1..1 The subject of the Products and Services. One of these 2 fhir:Claim.patientIdentifier [ Identifier ] fhir:Claim.patientReference [ Reference(Patient) ] fhir:Claim.coverage [ # 0..* Insurance or medical plan fhir:Claim.coverage.sequence [ positiveInt ]; # 1..1 Service instance identifier fhir:Claim.coverage.focal [ boolean ]; # 1..1 Is the focal Coverage # Claim.coverage.coverage[x] : 1..1 Insurance information. One of these 2 fhir:Claim.coverage.coverageIdentifier [ Identifier ] fhir:Claim.coverage.coverageReference [ Reference(Coverage) ] fhir:Claim.coverage.businessArrangement [ string ]; # 0..1 Business agreement fhir:Claim.coverage.preAuthRef [ string ], ... ; # 0..* Pre-Authorization/Determination Reference fhir:Claim.coverage.claimResponse [ Reference(ClaimResponse) ]; # 0..1 Adjudication results fhir:Claim.coverage.originalRuleset [ Coding ]; # 0..1 Original version ], ...; fhir:Claim.accident [ # 0..1 fhir:Claim.accident.date [ date ]; # 1..1 When the accident occurred see information codes see information codes fhir:Claim.accident.type [ Coding ]; # 0..1 The nature of the accident # Claim.accident.location[x] : 0..1 Accident Place. One of these 2 fhir:Claim.accident.locationAddress [ Address ] fhir:Claim.accident.locationReference [ Reference(Location) ] ]; fhir:Claim.employmentImpacted [ Period ]; # 0..1 Period unable to work fhir:Claim.hospitalization [ Period ]; # 0..1 Period in hospital fhir:Claim.item [ # 0..* Goods and Services fhir:Claim.item.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.careTeam [ # 0..* # Claim.item.careTeam.provider[x] : 1..1 Provider individual or organization. One of these 2 fhir:Claim.item.careTeam.providerIdentifier [ Identifier ] fhir:Claim.item.careTeam.providerReference [ Reference(Practitioner|Organization) ] fhir:Claim.item.careTeam.responsible [ boolean ]; # 0..1 Billing provider fhir:Claim.item.careTeam.role [ Coding ]; # 0..1 Role on the team fhir:Claim.item.careTeam.qualification [ Coding ]; # 0..1 Type, classification or Specialization ], ...; fhir:Claim.item.diagnosisLinkId [ positiveInt ], ... ; # 0..* Applicable diagnoses fhir:Claim.item.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion # Claim.item.serviced[x] : 0..1 Date or dates of Service. One of these 2 fhir:Claim.item.servicedDate [ date ] fhir:Claim.item.servicedPeriod [ Period ] # Claim.item.location[x] : 0..1 Place of service. One of these 3 fhir:Claim.item.locationCoding [ Coding ] fhir:Claim.item.locationAddress [ Address ] fhir:Claim.item.locationReference [ Reference(Location) ] fhir:Claim.item.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.net [ Money ]; # 0..1 Total item cost fhir:Claim.item.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.bodySite [ Coding ]; # 0..1 Service Location fhir:Claim.item.subSite [ Coding ], ... ; # 0..* Service Sub-location fhir:Claim.item.detail [ # 0..* Additional items fhir:Claim.item.detail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.detail.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.detail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion fhir:Claim.item.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.detail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.detail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.detail.net [ Money ]; # 0..1 Total additional item cost fhir:Claim.item.detail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier fhir:Claim.item.detail.subDetail [ # 0..* Additional items fhir:Claim.item.detail.subDetail.sequence [ positiveInt ]; # 1..1 Service instance fhir:Claim.item.detail.subDetail.revenue [ Coding ]; # 0..1 Revenue or cost center code fhir:Claim.item.detail.subDetail.category [ Coding ]; # 0..1 Type of service or product fhir:Claim.item.detail.subDetail.service [ Coding ]; # 0..1 Billing Code fhir:Claim.item.detail.subDetail.modifier [ Coding ], ... ; # 0..* Service/Product billing modifiers fhir:Claim.item.detail.subDetail.programCode [ Coding ], ... ; # 0..* Program specific reason for item inclusion fhir:Claim.item.detail.subDetail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Count of Products or Services fhir:Claim.item.detail.subDetail.unitPrice [ Money ]; # 0..1 Fee, charge or cost per point fhir:Claim.item.detail.subDetail.factor [ decimal ]; # 0..1 Price scaling factor fhir:Claim.item.detail.subDetail.points [ decimal ]; # 0..1 Difficulty scaling factor fhir:Claim.item.detail.subDetail.net [ Money ]; # 0..1 Net additional item cost fhir:Claim.item.detail.subDetail.udi [ Reference(Device) ], ... ; # 0..* Unique Device Identifier ], ...; ], ...; fhir:Claim.item.prosthesis [ # 0..1 Prosthetic details fhir:Claim.item.prosthesis.initial [ boolean ]; # 0..1 Is this the initial service fhir:Claim.item.prosthesis.priorDate [ date ]; # 0..1 Initial service Date fhir:Claim.item.prosthesis.priorMaterial [ Coding ]; # 0..1 Prosthetic Material ]; ], ...; fhir:Claim.total [ Money ]; # 0..1 Total claim cost fhir:Claim.missingTeeth [ # 0..* Only if type = oral fhir:Claim.missingTeeth.tooth [ Coding ]; # 1..1 Tooth Code fhir:Claim.missingTeeth.reason [ Coding ]; # 0..1 Indicates whether it was extracted or other reason fhir:Claim.missingTeeth.extractionDate [ date ]; # 0..1 Date tooth was extracted if known ], ...; ]
Changes since DSTU2
Claim | |
Claim.status | added |
Claim.type |
Type changed from code to Coding Change value set from http://hl7.org/fhir/ValueSet/claim-type-link to http://hl7.org/fhir/ValueSet/claim-type |
Claim.subType | added |
Claim.billablePeriod | added |
Claim.insurer[x] | added |
Claim.provider[x] |
Renamed from provider to provider[x] Add Identifier |
Claim.organization[x] |
Renamed from organization to organization[x] Add Identifier |
Claim.use | Change value set from http://hl7.org/fhir/ValueSet/claim-use-link to http://hl7.org/fhir/ValueSet/claim-use |
Claim.enterer[x] |
Renamed from enterer to enterer[x] Add Identifier |
Claim.facility[x] |
Renamed from facility to facility[x] Add Identifier |
Claim.related | added |
Claim.related.claim[x] | added |
Claim.related.relationship | added |
Claim.related.reference | added |
Claim.prescription[x] |
Renamed from prescription to prescription[x] Add Identifier |
Claim.originalPrescription[x] |
Renamed from originalPrescription to originalPrescription[x] Add Identifier |
Claim.payee.type | Min Cardinality changed from 0 to 1 |
Claim.payee.resourceType | added |
Claim.payee.party[x] | added |
Claim.referral[x] |
Renamed from referral to referral[x] Add Identifier |
Claim.information | added |
Claim.information.category | added |
Claim.information.code | added |
Claim.information.timing[x] | added |
Claim.information.value[x] | added |
Claim.diagnosis.type | added |
Claim.diagnosis.drg | added |
Claim.procedure | added |
Claim.procedure.sequence | added |
Claim.procedure.date | added |
Claim.procedure.procedure[x] | added |
Claim.patient[x] |
Renamed from patient to patient[x] Add Identifier |
Claim.coverage.coverage[x] |
Renamed from coverage to coverage[x] Add Identifier |
Claim.accident | Type changed from date to BackboneElement |
Claim.accident.date | added |
Claim.accident.type | added |
Claim.accident.location[x] | added |
Claim.employmentImpacted | added |
Claim.hospitalization | added |
Claim.item.careTeam | added |
Claim.item.careTeam.provider[x] | added |
Claim.item.careTeam.responsible | added |
Claim.item.careTeam.role | added |
Claim.item.careTeam.qualification | added |
Claim.item.revenue | added |
Claim.item.category | added |
Claim.item.service | Min Cardinality changed from 1 to 0 |
Claim.item.programCode | added |
Claim.item.serviced[x] | added |
Claim.item.location[x] | added |
Claim.item.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.item.detail.revenue | added |
Claim.item.detail.category | added |
Claim.item.detail.service | Min Cardinality changed from 1 to 0 |
Claim.item.detail.modifier | added |
Claim.item.detail.programCode | added |
Claim.item.detail.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.item.detail.subDetail.revenue | added |
Claim.item.detail.subDetail.category | added |
Claim.item.detail.subDetail.service | Min Cardinality changed from 1 to 0 |
Claim.item.detail.subDetail.modifier | added |
Claim.item.detail.subDetail.programCode | added |
Claim.item.detail.subDetail.unitPrice | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.subDetail.net | Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money |
Claim.item.detail.subDetail.udi |
Max Cardinality changed from 1 to * Type changed from Coding to Reference(Device) |
Claim.total | added |
Claim.target | deleted |
Claim.payee.provider | deleted |
Claim.payee.organization | deleted |
Claim.payee.person | deleted |
Claim.condition | deleted |
Claim.coverage.relationship | deleted |
Claim.exception | deleted |
Claim.school | deleted |
Claim.accidentType | deleted |
Claim.interventionException | deleted |
Claim.item.type | deleted |
Claim.item.provider | deleted |
Claim.item.serviceDate | deleted |
Claim.item.detail.type | deleted |
Claim.item.detail.subDetail.type | deleted |
Claim.additionalMaterials | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
Claim.status | A code specifying the state of the resource instance. | Required | ClaimStatus |
Claim.type | The type or discipline-style of the claim | Required | Example Claim Type Codes |
Claim.subType | A more granular claim typecode | Example | Example Claim SubType Codes |
Claim.ruleset Claim.originalRuleset Claim.coverage.originalRuleset | The static and dynamic model to which contents conform, which may be business version or standard/version. | Example | Ruleset Codes |
Claim.use | Complete, proposed, exploratory, other | Required | Use |
Claim.priority | The timeliness with which processing is required: STAT, normal, Deferred | Example | Priority Codes |
Claim.fundsReserve | For whom funds are to be reserved: (Patient, Provider, None). | Example | Funds Reservation Codes |
Claim.related.relationship | Relationship of this claim to a related Claim | Example | Example Related Claim Relationship Codes |
Claim.payee.type | A code for the party to be reimbursed. | Example | Payee Type Codes |
Claim.payee.resourceType | The type of payee Resource | Example | PayeeResourceType |
Claim.information.category | The valuset used for additional information category codes. | Example | Claim Information Category Codes |
Claim.information.code | The valuset used for additional information codes. | Example | Exception Codes |
Claim.diagnosis.diagnosis | ICD10 Diagnostic codes | Example | ICD-10 Codes |
Claim.diagnosis.type | The type of the diagnosis: admitting, principal, discharge | Example | Example Diagnosis Type Codes |
Claim.diagnosis.drg | The DRG codes associated with the diagnosis | Example | Example Diagnosis Related Group Codes |
Claim.procedure.procedure[x] | ICD10 Procedure codes | Example | ICD-10 Procedure Codes |
Claim.accident.type | Type of accident: work place, auto, etc. | Required | ActIncidentCode |
Claim.item.careTeam.role | The role codes for the care team members. | Example | Claim Care Team Role Codes |
Claim.item.careTeam.qualification | Provider professional qualifications | Example | Example Provider Qualification Codes |
Claim.item.revenue Claim.item.detail.revenue Claim.item.detail.subDetail.revenue | Codes for the revenue or cost centers supplying the service and/or products. | Example | Example Revenue Center Codes |
Claim.item.category Claim.item.detail.category Claim.item.detail.subDetail.category | Benefit subcategories such as: oral-basic, major, glasses | Example | Benefit SubCategory Codes |
Claim.item.service Claim.item.detail.service Claim.item.detail.subDetail.service | Allowable service and product codes | Example | USCLS Codes |
Claim.item.modifier Claim.item.detail.modifier Claim.item.detail.subDetail.modifier | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | Example | Modifier type Codes |
Claim.item.programCode Claim.item.detail.programCode Claim.item.detail.subDetail.programCode | Program specific reason codes | Example | Example Program Reason Codes |
Claim.item.location[x] | Place of service: pharmcy,school, prison, etc. | Example | Example Service Place Codes |
Claim.item.bodySite | The code for the teeth, quadrant, sextant and arch | Example | Oral Site Codes |
Claim.item.subSite | The code for the tooth surface and surface combinations | Example | Surface Codes |
Claim.item.prosthesis.priorMaterial | Material of the prior denture or bridge prosthesis. (Oral) | Example | Oral Prostho Material type Codes |
Claim.missingTeeth.tooth | The codes for the teeth, subset of OralSites | Example | Teeth Codes |
Claim.missingTeeth.reason | Reason codes for the missing teeth | Example | Missing Tooth Reason Codes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
created | date | The creation date for the Claim | Claim.created |
facility-identifier | token | Facility responsible for the goods and services | Claim.facilityIdentifier |
facility-reference | reference | Facility responsible for the goods and services | Claim.facilityReference (Location) |
identifier | token | The primary identifier of the financial resource | Claim.identifier |
insurer-identifier | token | The target payor/insurer for the Claim | Claim.insurerIdentifier |
insurer-reference | reference | The target payor/insurer for the Claim | Claim.insurerReference (Organization) |
organization-identifier | token | The reference to the providing organization | Claim.organizationIdentifier |
organization-reference | reference | The reference to the providing organization | Claim.organizationReference (Organization) |
patient-identifier | token | Patient receiving the services | Claim.patientIdentifier |
patient-reference | reference | Patient receiving the services | Claim.patientReference (Patient) |
priority | token | Processing priority requested | Claim.priority |
provider-identifier | token | Provider responsible for the Claim | Claim.providerIdentifier |
provider-reference | reference | Provider responsible for the Claim | Claim.providerReference (Practitioner) |
use | token | The kind of financial resource | Claim.use |