Claim
Defines the ID Core constraints and extensions on the Claim resource for the minimal set of data to query and retrieve claim information.
Usage
This profile is used by providers and payors, insurers, to exchange the financial information, and supporting clinical information, regarding the provision of health care services with payors and for reporting to regulatory bodies and firms which provide data analytics.
The primary uses of this resource is to support electronic claims, the exchange of information relating to the proposed or actual provision of healthcare-related goods and services for patients to their benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
URL
Type | URL |
---|---|
Canonical | https://fhir.kemkes.go.id/r4/StructureDefinition/Claim |
Structure
Snapshot
Claim | I | DomainResource | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | 0.. | ||
package | I | 0..1 | Extension |
id | 0..1 | string | |
extension | I | 2..* | Extension |
tariffClass | I | 1..* | Extension |
basePackage | I | 1..* | Extension |
additionalPackage | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueContributor | Contributor | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueReference | Reference() | ||
identifier | 0..* | Identifier | |
status | Σ ?! | 1..1 | codeBinding |
type | Σ | 1..1 | CodeableConceptBinding |
subType | 0..1 | CodeableConcept | |
use | Σ | 1..1 | codeBinding |
patient | Σ I | 1..1 | Reference(Patient) |
billablePeriod | Σ I | 0..1 | Period |
created | Σ | 1..1 | dateTime |
enterer | I | 0..1 | Reference(Practitioner | PractitionerRole) |
insurer | Σ I | 0..1 | Reference(Organization) |
provider | Σ I | 1..1 | Reference(Practitioner | PractitionerRole | Organization) |
priority | Σ | 1..1 | CodeableConcept |
fundsReserve | 0..1 | CodeableConcept | |
related | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
claim | I | 0..1 | Reference(Claim) |
relationship | 0..1 | CodeableConcept | |
reference | 0..1 | Identifier | |
prescription | I | 0..1 | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/DeviceRequest | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/VisionPrescription) |
originalPrescription | I | 0..1 | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/DeviceRequest | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/VisionPrescription) |
payee | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 1..1 | CodeableConcept | |
party | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) |
referral | I | 0..1 | Reference(ServiceRequest) |
facility | I | 0..1 | Reference(Location) |
careTeam | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
provider | I | 1..1 | Reference(Practitioner | PractitionerRole | Organization) |
responsible | 0..1 | boolean | |
role | 0..1 | CodeableConcept | |
qualification | 0..1 | CodeableConcept | |
supportingInfo | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
category | 1..1 | CodeableConcept | |
code | 0..1 | CodeableConcept | |
timing[x] | 0..1 | ||
timingDate | date | ||
timingPeriod | Period | ||
value[x] | 0..1 | ||
valueBoolean | boolean | ||
valueString | string | ||
valueQuantity | Quantity | ||
valueAttachment | Attachment | ||
valueReference | Reference(Resource) | ||
reason | 0..1 | CodeableConcept | |
diagnosis | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
diagnosis[x] | 1..1 | ||
diagnosisCodeableConcept | CodeableConcept | ||
diagnosisReference | Reference(Condition) | ||
type | 0..* | CodeableConcept | |
onAdmission | 0..1 | CodeableConcept | |
packageCode | 0..1 | CodeableConcept | |
procedure | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
type | 0..* | CodeableConcept | |
date | 0..1 | dateTime | |
procedure[x] | 1..1 | ||
procedureCodeableConcept | CodeableConcept | ||
procedureReference | Reference(Procedure) | ||
udi | I | 0..* | Reference() |
insurance | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | Σ | 1..1 | positiveInt |
focal | Σ | 1..1 | boolean |
identifier | 0..1 | Identifier | |
coverage | Σ I | 1..1 | Reference(Coverage) |
businessArrangement | 0..1 | string | |
preAuthRef | 0..* | string | |
claimResponse | I | 0..1 | Reference(ClaimResponse) |
accident | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
date | 1..1 | date | |
type | 0..1 | CodeableConceptBinding | |
location[x] | 0..1 | ||
locationAddress | Address | ||
locationReference | Reference(Location) | ||
item | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
careTeamSequence | 0..* | positiveInt | |
diagnosisSequence | 0..* | positiveInt | |
procedureSequence | 0..* | positiveInt | |
informationSequence | 0..* | positiveInt | |
revenue | 0..1 | CodeableConcept | |
category | 0..1 | CodeableConcept | |
productOrService | 1..1 | CodeableConcept | |
modifier | 0..* | CodeableConcept | |
programCode | 0..* | CodeableConcept | |
serviced[x] | 0..1 | ||
servicedDate | date | ||
servicedPeriod | Period | ||
location[x] | 0..1 | ||
locationCodeableConcept | CodeableConcept | ||
locationAddress | Address | ||
locationReference | Reference(Location) | ||
quantity | I | 0..1 | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
unitPrice | 0..1 | Money | |
factor | 0..1 | decimal | |
net | 0..1 | Money | |
udi | I | 0..* | Reference() |
bodySite | 0..1 | CodeableConcept | |
subSite | 0..* | CodeableConcept | |
encounter | I | 0..* | Reference(Encounter) |
detail | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
revenue | 0..1 | CodeableConcept | |
category | 0..1 | CodeableConcept | |
productOrService | 1..1 | CodeableConcept | |
modifier | 0..* | CodeableConcept | |
programCode | 0..* | CodeableConcept | |
quantity | I | 0..1 | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
unitPrice | 0..1 | Money | |
factor | 0..1 | decimal | |
net | 0..1 | Money | |
udi | I | 0..* | Reference() |
subDetail | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | 1..1 | positiveInt | |
revenue | 0..1 | CodeableConcept | |
category | 0..1 | CodeableConcept | |
productOrService | 1..1 | CodeableConcept | |
modifier | 0..* | CodeableConcept | |
programCode | 0..* | CodeableConcept | |
quantity | I | 0..1 | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
unitPrice | 0..1 | Money | |
factor | 0..1 | decimal | |
net | 0..1 | Money | |
udi | I | 0..* | Reference() |
total | 0..1 | Money |
Examples
Dictionary
Claim | |
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. |
Cardinality | 0...* |
Alias | Adjudication Request, Preauthorization Request, Predetermination Request |
Comments | The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services. |
Invariants |
|
Mappings |
|
Claim.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Claim.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Claim.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Claim.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Claim.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Claim.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Claim.extension | |
Cardinality | 0 |
Slicing | Unordered, Open, by url(Value) |
Claim.extension:package | |
Definition | Package Billing Information: - tariffClass - INACBG Code (basePackage) - Top Up Code (additionalPackage) |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Mappings |
|
Claim.extension:package.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.extension:package.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.extension:package.extension:tariffClass | |
Definition | Tariff Class for the hospital for the claim |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.extension:package.extension:basePackage | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.extension:package.extension:additionalPackage | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.extension:package.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | https://fhir.kemkes.go.id/r4/StructureDefinition/Package |
Mappings |
|
Claim.extension:package.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Claim.identifier | |
Definition | A unique identifier assigned to this claim. |
Cardinality | 0...* |
Type | Identifier |
Alias | Claim Number |
Requirements | Allows claims to be distinguished and referenced. |
Invariants |
|
Mappings |
|
Claim.status | |
Definition | The status of the resource instance. |
Cardinality | 1...1 |
Type | code |
Binding | A code specifying the state of the resource instance. |
Modifier | True |
Summary | True |
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Claim.type | |
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The type or discipline-style of the claim. |
Summary | True |
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. |
Comments | The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements. |
Invariants |
|
Mappings |
|
Claim.subType | |
Definition | A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A more granular claim typecode. |
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. |
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. |
Invariants |
|
Mappings |
|
Claim.use | |
Definition | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. |
Cardinality | 1...1 |
Type | code |
Binding | The purpose of the Claim: predetermination, preauthorization, claim. |
Summary | True |
Requirements | This element is required to understand the nature of the request for adjudication. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Claim.patient | |
Definition | The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Summary | True |
Requirements | The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.billablePeriod | |
Definition | The period for which charges are being submitted. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. |
Comments | Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified. |
Invariants |
|
Mappings |
|
Claim.created | |
Definition | The date this resource was created. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Comments | This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date. |
Invariants |
|
Mappings |
|
Claim.enterer | |
Definition | Individual who created the claim, predetermination or preauthorization. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Requirements | Some jurisdictions require the contact information for personnel completing claims. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.insurer | |
Definition | The Insurer who is target of the request. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.provider | |
Definition | The provider which is responsible for the claim, predetermination or preauthorization. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Summary | True |
Comments | Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below. |
Invariants |
|
Mappings |
|
Claim.priority | |
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The timeliness with which processing is required: stat, normal, deferred. |
Summary | True |
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply. |
Comments | If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request. |
Invariants |
|
Mappings |
|
Claim.fundsReserve | |
Definition | A code to indicate whether and for whom funds are to be reserved for future claims. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | For whom funds are to be reserved: (Patient, Provider, None). |
Alias | Fund pre-allocation |
Requirements | In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested. |
Comments | This field is only used for preauthorizations. |
Invariants |
|
Mappings |
|
Claim.related | |
Definition | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Comments | For example, for the original treatment and follow-up exams. |
Invariants |
|
Mappings |
|
Claim.related.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.related.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.related.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.related.claim | |
Definition | Reference to a related claim. |
Cardinality | 0...1 |
Type | Reference(Claim) |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.related.relationship | |
Definition | A code to convey how the claims are related. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Relationship of this claim to a related Claim. |
Requirements | Some insurers need a declaration of the type of relationship. |
Comments | For example, prior claim or umbrella. |
Invariants |
|
Mappings |
|
Claim.related.reference | |
Definition | An alternate organizational reference to the case or file to which this particular claim pertains. |
Cardinality | 0...1 |
Type | Identifier |
Requirements | In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges. |
Comments | For example, Property/Casualty insurer claim # or Workers Compensation case # . |
Invariants |
|
Mappings |
|
Claim.prescription | |
Definition | Prescription to support the dispensing of pharmacy, device or vision products. |
Cardinality | 0...1 |
Type | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/DeviceRequest | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/VisionPrescription) |
Requirements | Required to authorize the dispensing of controlled substances and devices. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.originalPrescription | |
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
Cardinality | 0...1 |
Type | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/DeviceRequest | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/VisionPrescription) |
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription. |
Comments | For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. |
Invariants |
|
Mappings |
|
Claim.payee | |
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. |
Comments | Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead. |
Invariants |
|
Mappings |
|
Claim.payee.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.payee.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.payee.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.payee.type | |
Definition | Type of Party to be reimbursed: subscriber, provider, other. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A code for the party to be reimbursed. |
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.payee.party | |
Definition | Reference to the individual or organization to whom any payment will be made. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) |
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. |
Comments | Not required if the payee is 'subscriber' or 'provider'. |
Invariants |
|
Mappings |
|
Claim.referral | |
Definition | A reference to a referral resource. |
Cardinality | 0...1 |
Type | Reference(ServiceRequest) |
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services. |
Comments | The referral resource which lists the date, practitioner, reason and other supporting information. |
Invariants |
|
Mappings |
|
Claim.facility | |
Definition | Facility where the services were provided. |
Cardinality | 0...1 |
Type | Reference(Location) |
Requirements | Insurance adjudication can be dependant on where services were delivered. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.careTeam | |
Definition | The members of the team who provided the products and services. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Common to identify the responsible and supporting practitioners. |
Invariants |
|
Mappings |
|
Claim.careTeam.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.careTeam.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.careTeam.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.careTeam.sequence | |
Definition | A number to uniquely identify care team entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.careTeam.provider | |
Definition | Member of the team who provided the product or service. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Requirements | Often a regulatory requirement to specify the responsible provider. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.careTeam.responsible | |
Definition | The party who is billing and/or responsible for the claimed products or services. |
Cardinality | 0...1 |
Type | boolean |
Requirements | When multiple parties are present it is required to distinguish the lead or responsible individual. |
Comments | Responsible might not be required when there is only a single provider listed. |
Invariants |
|
Mappings |
|
Claim.careTeam.role | |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The role codes for the care team members. |
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. |
Comments | Role might not be required when there is only a single provider listed. |
Invariants |
|
Mappings |
|
Claim.careTeam.qualification | |
Definition | The qualification of the practitioner which is applicable for this service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Provider professional qualifications. |
Requirements | Need to specify which qualification a provider is delivering the product or service under. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.supportingInfo | |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Cardinality | 0...* |
Type | BackboneElement |
Alias | Attachments Exception Codes Occurrence Codes Value codes |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Comments | Often there are multiple jurisdiction specific valuesets which are required. |
Invariants |
|
Mappings |
|
Claim.supportingInfo.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.supportingInfo.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.supportingInfo.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.supportingInfo.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.supportingInfo.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The valuset used for additional information category codes. |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Invariants |
|
Mappings |
|
Claim.supportingInfo.code | |
Definition | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The valuset used for additional information codes. |
Requirements | Required to identify the kind of additional information. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.supportingInfo.timing[x] | |
Definition | The date when or period to which this information refers. |
Cardinality | 0...1 |
Type | date |
Invariants |
|
Mappings |
|
Claim.supportingInfo.value[x] | |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Cardinality | 0...1 |
Type | boolean |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Comments | Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident. |
Invariants |
|
Mappings |
|
Claim.supportingInfo.reason | |
Definition | Provides the reason in the situation where a reason code is required in addition to the content. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Reason codes for the missing teeth. |
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. |
Comments | For example: the reason for the additional stay, or why a tooth is missing. |
Invariants |
|
Mappings |
|
Claim.diagnosis | |
Definition | Information about diagnoses relevant to the claim items. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Required for the adjudication by provided context for the services and product listed. |
Invariants |
|
Mappings |
|
Claim.diagnosis.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.diagnosis.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.diagnosis.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.diagnosis.sequence | |
Definition | A number to uniquely identify diagnosis entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details. |
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. |
Invariants |
|
Mappings |
|
Claim.diagnosis.diagnosis[x] | |
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Example ICD10 Diagnostic codes. |
Requirements | Provides health context for the evaluation of the products and/or services. |
Invariants |
|
Mappings |
|
Claim.diagnosis.type | |
Definition | When the condition was observed or the relative ranking. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The type of the diagnosis: admitting, principal, discharge. |
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. |
Comments | For example: admitting, primary, secondary, discharge. |
Invariants |
|
Mappings |
|
Claim.diagnosis.onAdmission | |
Definition | Indication of whether the diagnosis was present on admission to a facility. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Present on admission. |
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.diagnosis.packageCode | |
Definition | A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The DRG codes associated with the diagnosis. |
Requirements | Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code. |
Comments | For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. |
Invariants |
|
Mappings |
|
Claim.procedure | |
Definition | Procedures performed on the patient relevant to the billing items with the claim. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service. |
Invariants |
|
Mappings |
|
Claim.procedure.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.procedure.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.procedure.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.procedure.sequence | |
Definition | A number to uniquely identify procedure entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to claim details. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.procedure.type | |
Definition | When the condition was observed or the relative ranking. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Example procedure type codes. |
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. |
Comments | For example: primary, secondary. |
Invariants |
|
Mappings |
|
Claim.procedure.date | |
Definition | Date and optionally time the procedure was performed. |
Cardinality | 0...1 |
Type | dateTime |
Requirements | Required for auditing purposes. |
Invariants |
|
Mappings |
|
Claim.procedure.procedure[x] | |
Definition | The code or reference to a Procedure resource which identifies the clinical intervention performed. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Example ICD10 Procedure codes. |
Requirements | This identifies the actual clinical procedure. |
Invariants |
|
Mappings |
|
Claim.procedure.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0...* |
Type | Reference() |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.insurance | |
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Requirements | At least one insurer is required for a claim to be a claim. |
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim. |
Invariants |
|
Mappings |
|
Claim.insurance.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.insurance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.insurance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.insurance.sequence | |
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. |
Cardinality | 1...1 |
Type | positiveInt |
Summary | True |
Requirements | To maintain order of the coverages. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.insurance.focal | |
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
Requirements | To identify which coverage in the list is being used to adjudicate this claim. |
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies. |
Invariants |
|
Mappings |
|
Claim.insurance.identifier | |
Definition | The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
Cardinality | 0...1 |
Type | Identifier |
Requirements | This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication. |
Comments | Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'. |
Invariants |
|
Mappings |
|
Claim.insurance.coverage | |
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
Cardinality | 1...1 |
Type | Reference(Coverage) |
Summary | True |
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.insurance.businessArrangement | |
Definition | A business agreement number established between the provider and the insurer for special business processing purposes. |
Cardinality | 0...1 |
Type | string |
Requirements | Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Claim.insurance.preAuthRef | |
Definition | Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. |
Cardinality | 0...* |
Type | string |
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization. |
Comments | This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier. |
Invariants |
|
Mappings |
|
Claim.insurance.claimResponse | |
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance. |
Cardinality | 0...1 |
Type | Reference(ClaimResponse) |
Requirements | An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim. |
Comments | Must not be specified when 'focal=true' for this insurance. |
Invariants |
|
Mappings |
|
Claim.accident | |
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim. |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance. |
Invariants |
|
Mappings |
|
Claim.accident.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.accident.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.accident.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.accident.date | |
Definition | Date of an accident event related to the products and services contained in the claim. |
Cardinality | 1...1 |
Type | date |
Requirements | Required for audit purposes and adjudication. |
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe. |
Invariants |
|
Mappings |
|
Claim.accident.type | |
Definition | The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Type of accident: work place, auto, etc. |
Requirements | Coverage may be dependant on the type of accident. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.accident.location[x] | |
Definition | The physical location of the accident event. |
Cardinality | 0...1 |
Type | Address |
Requirements | Required for audit purposes and determination of applicable insurance liability. |
Invariants |
|
Mappings |
|
Claim.item | |
Definition | A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | The items to be processed for adjudication. |
Invariants |
|
Mappings |
|
Claim.item.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.item.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.item.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.item.sequence | |
Definition | A number to uniquely identify item entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.careTeamSequence | |
Definition | CareTeam members related to this service or product. |
Cardinality | 0...* |
Type | positiveInt |
Requirements | Need to identify the individuals and their roles in the provision of the product or service. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.diagnosisSequence | |
Definition | Diagnosis applicable for this service or product. |
Cardinality | 0...* |
Type | positiveInt |
Requirements | Need to related the product or service to the associated diagnoses. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.procedureSequence | |
Definition | Procedures applicable for this service or product. |
Cardinality | 0...* |
Type | positiveInt |
Requirements | Need to provide any listed specific procedures to support the product or service being claimed. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.informationSequence | |
Definition | Exceptions, special conditions and supporting information applicable for this service or product. |
Cardinality | 0...* |
Type | positiveInt |
Requirements | Need to reference the supporting information items that relate directly to this product or service. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.revenue | |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the revenue or cost centers supplying the service and/or products. |
Requirements | Needed in the processing of institutional claims. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.item.category | |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Benefit categories such as: oral-basic, major, glasses. |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Invariants |
|
Mappings |
|
Claim.item.productOrService | |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Allowable service and product codes. |
Alias | Drug Code, Bill Code, Service Code |
Requirements | Necessary to state what was provided or done. |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. |
Invariants |
|
Mappings |
|
Claim.item.modifier | |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. |
Invariants |
|
Mappings |
|
Claim.item.programCode | |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Program specific reason codes. |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Invariants |
|
Mappings |
|
Claim.item.serviced[x] | |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Cardinality | 0...1 |
Type | date |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Invariants |
|
Mappings |
|
Claim.item.location[x] | |
Definition | Where the product or service was provided. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Place of service: pharmacy, school, prison, etc. |
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount. |
Invariants |
|
Mappings |
|
Claim.item.quantity | |
Definition | The number of repetitions of a service or product. |
Cardinality | 0...1 |
Type | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Claim.item.unitPrice | |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0...1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants |
|
Mappings |
|
Claim.item.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Cardinality | 0...1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Invariants |
|
Mappings |
|
Claim.item.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0...1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Invariants |
|
Mappings |
|
Claim.item.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0...* |
Type | Reference() |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.item.bodySite | |
Definition | Physical service site on the patient (limb, tooth, etc.). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The code for the teeth, quadrant, sextant and arch. |
Requirements | Allows insurer to validate specific procedures. |
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. |
Invariants |
|
Mappings |
|
Claim.item.subSite | |
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The code for the tooth surface and surface combinations. |
Requirements | Allows insurer to validate specific procedures. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.item.encounter | |
Definition | The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
Cardinality | 0...* |
Type | Reference(Encounter) |
Requirements | Used in some jurisdictions to link clinical events to claim items. |
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. |
Invariants |
|
Mappings |
|
Claim.item.detail | |
Definition | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | The items to be processed for adjudication. |
Invariants |
|
Mappings |
|
Claim.item.detail.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.item.detail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.item.detail.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.item.detail.sequence | |
Definition | A number to uniquely identify item entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.detail.revenue | |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the revenue or cost centers supplying the service and/or products. |
Requirements | Needed in the processing of institutional claims. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.item.detail.category | |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Benefit categories such as: oral-basic, major, glasses. |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Invariants |
|
Mappings |
|
Claim.item.detail.productOrService | |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Allowable service and product codes. |
Alias | Drug Code, Bill Code, Service Code |
Requirements | Necessary to state what was provided or done. |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. |
Invariants |
|
Mappings |
|
Claim.item.detail.modifier | |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. |
Invariants |
|
Mappings |
|
Claim.item.detail.programCode | |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Program specific reason codes. |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Invariants |
|
Mappings |
|
Claim.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Cardinality | 0...1 |
Type | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Claim.item.detail.unitPrice | |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0...1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants |
|
Mappings |
|
Claim.item.detail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Cardinality | 0...1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Invariants |
|
Mappings |
|
Claim.item.detail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0...1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Invariants |
|
Mappings |
|
Claim.item.detail.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0...* |
Type | Reference() |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail | |
Definition | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | The items to be processed for adjudication. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Claim.item.detail.subDetail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.sequence | |
Definition | A number to uniquely identify item entries. |
Cardinality | 1...1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.revenue | |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes for the revenue or cost centers supplying the service and/or products. |
Requirements | Needed in the processing of institutional claims. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.category | |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Benefit categories such as: oral-basic, major, glasses. |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.productOrService | |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Allowable service and product codes. |
Requirements | Necessary to state what was provided or done. |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.modifier | |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.programCode | |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Program specific reason codes. |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Cardinality | 0...1 |
Type | https://fhir.kemkes.go.id/r4/StructureDefinition/SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.unitPrice | |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0...1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Cardinality | 0...1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0...1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Invariants |
|
Mappings |
|
Claim.item.detail.subDetail.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0...* |
Type | Reference() |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Claim.total | |
Definition | The total value of the all the items in the claim. |
Cardinality | 0...1 |
Type | Money |
Requirements | Used for control total purposes. |
Invariants |
|
Mappings |
|