FHIR Implementation Guide for HCX
0.7.0 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.7.0). See the Directory of published versions
Defining URL: | https://ig.hcxprotocol.io/v0.7/StructureDefinition-Claim.html |
Version: | 0.7.0 |
Name: | Claim |
Status: | Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use) |
Definition: | A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement. |
Publisher: | HCX Open Community |
Maturity: | 1 |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ig.hcxprotocol.io/v0.7/StructureDefinition-Claim.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Claim
Summary
Mandatory: 9 elements (5 nested mandatory elements)
Structures
This structure refers to these other structures:
Maturity: 1
This structure is derived from Claim
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |
identifier | 1..* | Identifier | Business Identifier for claim | |
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |
insurer | Σ | 1..1 | Reference(Organization) | Target |
provider | Σ | 1..1 | Reference(Practitioner | Organization) | Party responsible for the claim |
related | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
payee | 1..1 | BackboneElement | Recipient of benefits payable | |
party | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |
careTeam | 1..* | BackboneElement | Members of the care team | |
provider | 1..1 | Reference(Practitioner | Organization) | Practitioner or organization | |
role | 0..1 | CodeableConcept | Function within the team Binding: https://nrces.in/ndhm/fhir/r4/ValueSet-ndhm-practitioner-role.html (example): The role codes for the care team members. | |
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: MedicalSpecialityTypeProvider (example): Provider specialization. | |
supportingInfo | ||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimSupportingInfoCategories (example): The valuset used for additional information category codes. | |
code | 0..1 | CodeableConcept | Type of information Binding: ClaimSupportingInfoCodes (example): The valuset used for additional information codes. | |
diagnosis | ||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 1..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |
procedure | ||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ProcedureTypeDescriptions (example): Sample Procedure codes. | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
insurance | ||||
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
item | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral-basic, major, glasses. | |
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
detail | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BillingSubgroupCategories (example): Benefit categories such as: oral-basic, major, glasses. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..* | Identifier | Business Identifier for claim | |||||
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | Σ | 1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
subType | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
use | Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | ||||
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim | ||||
created | Σ | 1..1 | dateTime | Resource creation date | ||||
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |||||
insurer | Σ | 1..1 | Reference(Organization) | Target | ||||
provider | Σ | 1..1 | Reference(Practitioner | Organization) | Party responsible for the claim | ||||
priority | Σ | 1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. | ||||
fundsReserve | 0..1 | CodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
related | 0..* | BackboneElement | Prior or corollary claims | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |||||
relationship | 0..1 | CodeableConcept | How the reference claim is related Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim. | |||||
reference | 0..1 | Identifier | File or case reference | |||||
prescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
payee | 1..1 | BackboneElement | Recipient of benefits payable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
party | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |||||
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
careTeam | 1..* | BackboneElement | Members of the care team | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Order of care team | |||||
provider | 1..1 | Reference(Practitioner | Organization) | Practitioner or organization | |||||
responsible | 0..1 | boolean | Indicator of the lead practitioner | |||||
role | 0..1 | CodeableConcept | Function within the team Binding: https://nrces.in/ndhm/fhir/r4/ValueSet-ndhm-practitioner-role.html (example): The role codes for the care team members. | |||||
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: MedicalSpecialityTypeProvider (example): Provider specialization. | |||||
supportingInfo | 0..* | BackboneElement | Supporting information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimSupportingInfoCategories (example): The valuset used for additional information category codes. | |||||
code | 0..1 | CodeableConcept | Type of information Binding: ClaimSupportingInfoCodes (example): The valuset used for additional information codes. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | 0..1 | Data to be provided | ||||||
valueBoolean | boolean | |||||||
valueString | string | |||||||
valueQuantity | Quantity | |||||||
valueAttachment | Attachment | |||||||
valueReference | Reference(Resource) | |||||||
reason | 0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Diagnosis instance identifier | |||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
type | 1..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |||||
onAdmission | 0..1 | CodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. | |||||
packageCode | 0..1 | CodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. | |||||
procedure | 0..* | BackboneElement | Clinical procedures performed | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Procedure instance identifier | |||||
type | 0..* | CodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. | |||||
date | 0..1 | dateTime | When the procedure was performed | |||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ProcedureTypeDescriptions (example): Sample Procedure codes. | ||||||
procedureCodeableConcept | CodeableConcept | |||||||
procedureReference | Reference(Procedure) | |||||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
insurance | Σ | 1..* | BackboneElement | Patient insurance information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 1..1 | positiveInt | Insurance instance identifier | ||||
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication | ||||
identifier | 0..1 | Identifier | Pre-assigned Claim number | |||||
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information | ||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 1..1 | date | When the incident occurred | |||||
type | 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. | |||||
location[x] | 0..1 | Where the event occurred | ||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
item | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
careTeamSequence | 0..* | positiveInt | Applicable careTeam members | |||||
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |||||
procedureSequence | 0..* | positiveInt | Applicable procedures | |||||
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | 0..1 | Date or dates of service or product delivery | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
detail | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BillingSubgroupCategories (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
subDetail | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
total | 0..1 | Money | Total claim cost | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |
Documentation for this format |
This structure is derived from Claim
Summary
Mandatory: 9 elements (5 nested mandatory elements)
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from Claim
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |
identifier | 1..* | Identifier | Business Identifier for claim | |
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |
insurer | Σ | 1..1 | Reference(Organization) | Target |
provider | Σ | 1..1 | Reference(Practitioner | Organization) | Party responsible for the claim |
related | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |
payee | 1..1 | BackboneElement | Recipient of benefits payable | |
party | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |
careTeam | 1..* | BackboneElement | Members of the care team | |
provider | 1..1 | Reference(Practitioner | Organization) | Practitioner or organization | |
role | 0..1 | CodeableConcept | Function within the team Binding: https://nrces.in/ndhm/fhir/r4/ValueSet-ndhm-practitioner-role.html (example): The role codes for the care team members. | |
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: MedicalSpecialityTypeProvider (example): Provider specialization. | |
supportingInfo | ||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimSupportingInfoCategories (example): The valuset used for additional information category codes. | |
code | 0..1 | CodeableConcept | Type of information Binding: ClaimSupportingInfoCodes (example): The valuset used for additional information codes. | |
diagnosis | ||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
type | 1..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |
procedure | ||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ProcedureTypeDescriptions (example): Sample Procedure codes. | ||
procedureCodeableConcept | CodeableConcept | |||
procedureReference | Reference(Procedure) | |||
insurance | ||||
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information |
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |
item | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral-basic, major, glasses. | |
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |
detail | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BillingSubgroupCategories (example): Benefit categories such as: oral-basic, major, glasses. | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Claim | 0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..* | Identifier | Business Identifier for claim | |||||
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
type | Σ | 1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
subType | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
use | Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | ||||
patient | Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
billablePeriod | Σ | 0..1 | Period | Relevant time frame for the claim | ||||
created | Σ | 1..1 | dateTime | Resource creation date | ||||
enterer | 0..1 | Reference(Practitioner | PractitionerRole) | Author of the claim | |||||
insurer | Σ | 1..1 | Reference(Organization) | Target | ||||
provider | Σ | 1..1 | Reference(Practitioner | Organization) | Party responsible for the claim | ||||
priority | Σ | 1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. | ||||
fundsReserve | 0..1 | CodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
related | 0..* | BackboneElement | Prior or corollary claims | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
claim | 0..1 | Reference(Claim) | Reference to the related claim | |||||
relationship | 0..1 | CodeableConcept | How the reference claim is related Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim. | |||||
reference | 0..1 | Identifier | File or case reference | |||||
prescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
originalPrescription | 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
payee | 1..1 | BackboneElement | Recipient of benefits payable | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
party | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | |||||
referral | 0..1 | Reference(ServiceRequest) | Treatment referral | |||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
careTeam | 1..* | BackboneElement | Members of the care team | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Order of care team | |||||
provider | 1..1 | Reference(Practitioner | Organization) | Practitioner or organization | |||||
responsible | 0..1 | boolean | Indicator of the lead practitioner | |||||
role | 0..1 | CodeableConcept | Function within the team Binding: https://nrces.in/ndhm/fhir/r4/ValueSet-ndhm-practitioner-role.html (example): The role codes for the care team members. | |||||
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: MedicalSpecialityTypeProvider (example): Provider specialization. | |||||
supportingInfo | 0..* | BackboneElement | Supporting information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Information instance identifier | |||||
category | 1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimSupportingInfoCategories (example): The valuset used for additional information category codes. | |||||
code | 0..1 | CodeableConcept | Type of information Binding: ClaimSupportingInfoCodes (example): The valuset used for additional information codes. | |||||
timing[x] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | 0..1 | Data to be provided | ||||||
valueBoolean | boolean | |||||||
valueString | string | |||||||
valueQuantity | Quantity | |||||||
valueAttachment | Attachment | |||||||
valueReference | Reference(Resource) | |||||||
reason | 0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Diagnosis instance identifier | |||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
type | 1..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |||||
onAdmission | 0..1 | CodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. | |||||
packageCode | 0..1 | CodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. | |||||
procedure | 0..* | BackboneElement | Clinical procedures performed | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Procedure instance identifier | |||||
type | 0..* | CodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. | |||||
date | 0..1 | dateTime | When the procedure was performed | |||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ProcedureTypeDescriptions (example): Sample Procedure codes. | ||||||
procedureCodeableConcept | CodeableConcept | |||||||
procedureReference | Reference(Procedure) | |||||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
insurance | Σ | 1..* | BackboneElement | Patient insurance information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 1..1 | positiveInt | Insurance instance identifier | ||||
focal | Σ | 1..1 | boolean | Coverage to be used for adjudication | ||||
identifier | 0..1 | Identifier | Pre-assigned Claim number | |||||
coverage | Σ | 1..1 | Reference(Coverage) | Insurance information | ||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
claimResponse | 0..1 | Reference(ClaimResponse) | Adjudication results | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 1..1 | date | When the incident occurred | |||||
type | 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. | |||||
location[x] | 0..1 | Where the event occurred | ||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
item | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
careTeamSequence | 0..* | positiveInt | Applicable careTeam members | |||||
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |||||
procedureSequence | 0..* | positiveInt | Applicable procedures | |||||
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | 0..1 | Date or dates of service or product delivery | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
detail | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BillingSubgroupCategories (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
subDetail | 0..* | BackboneElement | Product or service provided | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Item instance identifier | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
total | 0..1 | Money | Total claim cost | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |