SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/claim | Version: 0.1.0 | |||
| Active as of 2026-10-20 | Computable Name: HIEClaim | |||
R4B Claim constrained for HIE submission and exchange. Emphasizes core administrative data, patient, provider, insurer, billable period, coverage, diagnosis, items, and totals.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | |
![]() ![]() |
C | 1..1 | HIECodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Constraints: cc-text-or-code |
![]() ![]() |
C | 0..1 | HIECodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. Constraints: cc-text-or-code |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | |
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |
![]() ![]() |
C | 1..1 | HIECodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Constraints: cc-text-or-code |
![]() ![]() |
C | 0..1 | HIECodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). Constraints: cc-text-or-code |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Diagnosis instance identifier | |
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Closed by type:$this Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Constraints: cc-text-or-code |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. Constraints: cc-text-or-code |
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |
![]() ![]() |
1..* | BackboneElement | Product or service provided | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. Constraints: cc-text-or-code |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |
![]() ![]() |
1..1 | Money | Total claim cost | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.3.0 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.subType | Base | example | Example Claim SubType Codes | 📍4.3.0 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.3.0 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.3.0 | FHIR Std. |
| Claim.fundsReserve | Base | example | FundsReserve | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.bodySite | Base | example | Oral Site Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.subSite | Base | example | Surface Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Claim.identifier.type, Claim.type, Claim.subType, Claim.priority, Claim.fundsReserve, Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept, Claim.diagnosis.type, Claim.diagnosis.onAdmission, Claim.diagnosis.packageCode, Claim.item.revenue, Claim.item.category, Claim.item.productOrService, Claim.item.modifier, Claim.item.programCode, Claim.item.bodySite, Claim.item.subSite | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Claim | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Claim
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error | |
![]() ![]() |
1..1 | HIECodeableConcept | Category or discipline | |
![]() ![]() |
0..1 | HIECodeableConcept | More granular claim type | |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination | |
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |
![]() ![]() |
1..1 | HIECodeableConcept | Desired processing ugency | |
![]() ![]() |
0..1 | HIECodeableConcept | For whom to reserve funds | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Claim) | Reference to the related claim | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Category of recipient | |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization | HIE Patient | RelatedPerson) | Recipient reference | |
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Practitioner or organization | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Function within the team | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Practitioner credential or specialization | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Classification of the supplied information | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Type of information | |
![]() ![]() ![]() |
0..1 | Data to be provided Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Resource) | Data to be provided | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Explanation for the information | |
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Nature of illness or problem | |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Timing or nature of the diagnosis | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Present on admission | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Package billing code | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | HIECodeableConcept | Category of Procedure | |
![]() ![]() ![]() |
1..1 | Specific clinical procedure Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Procedure) | |||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Specific clinical procedure | |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Procedure) | Specific clinical procedure | |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | The nature of the accident | |
![]() ![]() |
1..* | BackboneElement | Product or service provided | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Product or service billing modifiers | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Program the product or service is provided under | |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Anatomical location | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Anatomical sub-location | |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Service/Product billing modifiers | |
![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Service/Product billing modifiers | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Program the product or service is provided under | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() |
1..1 | Money | Total claim cost | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | |||||
![]() ![]() |
C | 1..1 | HIECodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Constraints: cc-text-or-code | ||||
![]() ![]() |
C | 0..1 | HIECodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. Constraints: cc-text-or-code | ||||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | |||||
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |||||
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |||||
![]() ![]() |
1..1 | dateTime | Resource creation date | |||||
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |||||
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |||||
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |||||
![]() ![]() |
C | 1..1 | HIECodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Constraints: cc-text-or-code | ||||
![]() ![]() |
C | 0..1 | HIECodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Prior or corollary claims | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Claim) | Reference to the related claim | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How the reference claim is related Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim. | |||||
![]() ![]() ![]() |
0..1 | Identifier | File or case reference | |||||
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
![]() ![]() |
0..1 | BackboneElement | Recipient of benefits payable | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization | HIE Patient | RelatedPerson) | Recipient reference | |||||
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |||||
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |||||
![]() ![]() |
0..* | BackboneElement | Members of the care team | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Order of care team | |||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Practitioner or organization | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicator of the lead practitioner | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Function within the team Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Practitioner credential or specialization Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications. Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Supporting information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Data to be provided Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Resource) | Data to be provided | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. Constraints: cc-text-or-code | ||||
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Diagnosis instance identifier | |||||
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Closed by type:$this Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Clinical procedures performed | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Procedure instance identifier | |||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the procedure was performed | |||||
![]() ![]() ![]() |
1..1 | Specific clinical procedure Slice: Unordered, Closed by type:$this Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Procedure) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Specific clinical procedure Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Procedure) | Specific clinical procedure | |||||
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-assigned Claim number | |||||
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..* | string | Prior authorization reference number | |||||
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |||||
![]() ![]() |
0..1 | BackboneElement | Details of the event | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | date | When the incident occurred | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | Where the event occurred | ||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() |
1..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable careTeam members | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable diagnoses | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable procedures | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable exception and supporting information | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() |
1..1 | Money | Total claim cost | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.3.0 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.subType | Base | example | Example Claim SubType Codes | 📍4.3.0 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.3.0 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.3.0 | FHIR Std. |
| Claim.fundsReserve | Base | example | FundsReserve | 📍4.3.0 | FHIR Std. |
| Claim.related.relationship | Base | example | Example Related Claim Relationship Codes | 📍4.3.0 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.3.0 | FHIR Std. |
| Claim.careTeam.role | Base | example | Claim Care Team Role Codes | 📍4.3.0 | FHIR Std. |
| Claim.careTeam.qualification | Base | example | Example Provider Qualification Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.code | Base | example | Exception Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.reason | Base | example | Missing Tooth Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.type | Base | example | Example Procedure Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.procedure[x]:procedureCodeableConcept | Base | example | ICD-10 Procedure Codes | 📍4.3.0 | FHIR Std. |
| Claim.accident.type | Base | extensible | ActIncidentCode | 📦3.0.0 | THO v7.4 |
| Claim.item.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.location[x] | Base | example | Example Service Place Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.bodySite | Base | example | Oral Site Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.subSite | Base | example | Surface Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Claim.identifier.type, Claim.type, Claim.subType, Claim.priority, Claim.fundsReserve, Claim.payee.type, Claim.careTeam.role, Claim.careTeam.qualification, Claim.supportingInfo.category, Claim.supportingInfo.code, Claim.supportingInfo.reason, Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept, Claim.diagnosis.type, Claim.diagnosis.onAdmission, Claim.diagnosis.packageCode, Claim.procedure.type, Claim.procedure.procedure[x]:procedureCodeableConcept, Claim.accident.type, Claim.item.revenue, Claim.item.category, Claim.item.productOrService, Claim.item.modifier, Claim.item.programCode, Claim.item.bodySite, Claim.item.subSite, Claim.item.detail.revenue, Claim.item.detail.category, Claim.item.detail.productOrService, Claim.item.detail.modifier, Claim.item.detail.subDetail.revenue, Claim.item.detail.subDetail.category, Claim.item.detail.subDetail.productOrService, Claim.item.detail.subDetail.modifier, Claim.item.detail.subDetail.programCode | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Claim | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Claim.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Claim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Claim
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | |
![]() ![]() |
C | 1..1 | HIECodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Constraints: cc-text-or-code |
![]() ![]() |
C | 0..1 | HIECodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. Constraints: cc-text-or-code |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | |
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |
![]() ![]() |
C | 1..1 | HIECodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Constraints: cc-text-or-code |
![]() ![]() |
C | 0..1 | HIECodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). Constraints: cc-text-or-code |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Diagnosis instance identifier | |
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Closed by type:$this Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Constraints: cc-text-or-code |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. Constraints: cc-text-or-code |
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |
![]() ![]() |
1..* | BackboneElement | Product or service provided | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. Constraints: cc-text-or-code |
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. Constraints: cc-text-or-code |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |
![]() ![]() |
1..1 | Money | Total claim cost | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.3.0 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.subType | Base | example | Example Claim SubType Codes | 📍4.3.0 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.3.0 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.3.0 | FHIR Std. |
| Claim.fundsReserve | Base | example | FundsReserve | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.bodySite | Base | example | Oral Site Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.subSite | Base | example | Surface Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Claim.identifier.type, Claim.type, Claim.subType, Claim.priority, Claim.fundsReserve, Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept, Claim.diagnosis.type, Claim.diagnosis.onAdmission, Claim.diagnosis.packageCode, Claim.item.revenue, Claim.item.category, Claim.item.productOrService, Claim.item.modifier, Claim.item.programCode, Claim.item.bodySite, Claim.item.subSite | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Claim | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Claim
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error | |
![]() ![]() |
1..1 | HIECodeableConcept | Category or discipline | |
![]() ![]() |
0..1 | HIECodeableConcept | More granular claim type | |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination | |
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |
![]() ![]() |
1..1 | HIECodeableConcept | Desired processing ugency | |
![]() ![]() |
0..1 | HIECodeableConcept | For whom to reserve funds | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Claim) | Reference to the related claim | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Category of recipient | |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization | HIE Patient | RelatedPerson) | Recipient reference | |
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Practitioner or organization | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Function within the team | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Practitioner credential or specialization | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Classification of the supplied information | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Type of information | |
![]() ![]() ![]() |
0..1 | Data to be provided Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Resource) | Data to be provided | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Explanation for the information | |
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Nature of illness or problem | |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Timing or nature of the diagnosis | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Present on admission | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Package billing code | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | HIECodeableConcept | Category of Procedure | |
![]() ![]() ![]() |
1..1 | Specific clinical procedure Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Procedure) | |||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Specific clinical procedure | |
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Procedure) | Specific clinical procedure | |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | HIECodeableConcept | The nature of the accident | |
![]() ![]() |
1..* | BackboneElement | Product or service provided | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Product or service billing modifiers | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Program the product or service is provided under | |
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() |
0..1 | HIECodeableConcept | Anatomical location | |
![]() ![]() ![]() |
0..* | HIECodeableConcept | Anatomical sub-location | |
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Service/Product billing modifiers | |
![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Revenue or cost center code | |
![]() ![]() ![]() ![]() ![]() |
0..1 | HIECodeableConcept | Benefit classification | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HIECodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Service/Product billing modifiers | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIECodeableConcept | Program the product or service is provided under | |
![]() ![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |
![]() ![]() |
1..1 | Money | Total claim cost | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | Identifier | Business Identifier for claim | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | |||||
![]() ![]() |
C | 1..1 | HIECodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Constraints: cc-text-or-code | ||||
![]() ![]() |
C | 0..1 | HIECodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. Constraints: cc-text-or-code | ||||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. | |||||
![]() ![]() |
1..1 | HIEReference(HIE Patient) | The recipient of the products and services | |||||
![]() ![]() |
1..1 | Period | Relevant time frame for the claim | |||||
![]() ![]() |
1..1 | dateTime | Resource creation date | |||||
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | PractitionerRole) | Author of the claim | |||||
![]() ![]() |
0..1 | HIEReference(HIE Organization) | Target | |||||
![]() ![]() |
1..1 | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Party responsible for the claim | |||||
![]() ![]() |
C | 1..1 | HIECodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Constraints: cc-text-or-code | ||||
![]() ![]() |
C | 0..1 | HIECodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Prior or corollary claims | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | HIEReference(HIE Claim) | Reference to the related claim | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How the reference claim is related Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim. | |||||
![]() ![]() ![]() |
0..1 | Identifier | File or case reference | |||||
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | |||||
![]() ![]() |
0..1 | HIEReference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | |||||
![]() ![]() |
0..1 | BackboneElement | Recipient of benefits payable | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Category of recipient Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization | HIE Patient | RelatedPerson) | Recipient reference | |||||
![]() ![]() |
0..1 | HIEReference(ServiceRequest) | Treatment referral | |||||
![]() ![]() |
0..1 | HIEReference(Location) | Servicing facility | |||||
![]() ![]() |
0..* | BackboneElement | Members of the care team | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Order of care team | |||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Practitioner or organization | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicator of the lead practitioner | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Function within the team Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Practitioner credential or specialization Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications. Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Supporting information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Data to be provided Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Resource) | Data to be provided | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. Constraints: cc-text-or-code | ||||
![]() ![]() |
1..* | BackboneElement | Pertinent diagnosis information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Diagnosis instance identifier | |||||
![]() ![]() ![]() |
1..1 | Nature of illness or problem Slice: Unordered, Closed by type:$this Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Condition) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Nature of illness or problem Binding: ICD-10Codes (example): Example ICD10 Diagnostic codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Condition) | Nature of illness or problem | |||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. Constraints: cc-text-or-code | ||||
![]() ![]() |
0..* | BackboneElement | Clinical procedures performed | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Procedure instance identifier | |||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the procedure was performed | |||||
![]() ![]() ![]() |
1..1 | Specific clinical procedure Slice: Unordered, Closed by type:$this Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Procedure) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Specific clinical procedure Binding: ICD-10ProcedureCodes (example): Example ICD10 Procedure codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..1 | HIEReference(Procedure) | Specific clinical procedure | |||||
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() |
1..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-assigned Claim number | |||||
![]() ![]() ![]() |
1..1 | HIEReference(Coverage) | Insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..* | string | Prior authorization reference number | |||||
![]() ![]() ![]() |
0..1 | HIEReference(ClaimResponse) | Adjudication results | |||||
![]() ![]() |
0..1 | BackboneElement | Details of the event | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | date | When the incident occurred | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | Where the event occurred | ||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() |
1..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable careTeam members | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable diagnoses | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable procedures | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable exception and supporting information | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Encounters related to this billed item | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Product or service provided | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | HIECodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral-basic, major, glasses. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | HIECodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | HIECodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. Constraints: cc-text-or-code | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.3.0) | Count of products or services Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | HIEReference(Device) | Unique device identifier | |||||
![]() ![]() |
1..1 | Money | Total claim cost | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Claim.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.3.0 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.subType | Base | example | Example Claim SubType Codes | 📍4.3.0 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.3.0 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.3.0 | FHIR Std. |
| Claim.fundsReserve | Base | example | FundsReserve | 📍4.3.0 | FHIR Std. |
| Claim.related.relationship | Base | example | Example Related Claim Relationship Codes | 📍4.3.0 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.3.0 | FHIR Std. |
| Claim.careTeam.role | Base | example | Claim Care Team Role Codes | 📍4.3.0 | FHIR Std. |
| Claim.careTeam.qualification | Base | example | Example Provider Qualification Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.code | Base | example | Exception Codes | 📍4.3.0 | FHIR Std. |
| Claim.supportingInfo.reason | Base | example | Missing Tooth Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | Base | example | ICD-10 Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.3.0 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.type | Base | example | Example Procedure Type Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.3.0 | FHIR Std. |
| Claim.procedure.procedure[x]:procedureCodeableConcept | Base | example | ICD-10 Procedure Codes | 📍4.3.0 | FHIR Std. |
| Claim.accident.type | Base | extensible | ActIncidentCode | 📦3.0.0 | THO v7.4 |
| Claim.item.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.location[x] | Base | example | Example Service Place Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.bodySite | Base | example | Oral Site Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.subSite | Base | example | Surface Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.revenue | Base | example | Example Revenue Center Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.category | Base | example | Benefit Category Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.3.0 | FHIR Std. |
| Claim.item.detail.subDetail.programCode | Base | example | Example Program Reason Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Claim.identifier.type, Claim.type, Claim.subType, Claim.priority, Claim.fundsReserve, Claim.payee.type, Claim.careTeam.role, Claim.careTeam.qualification, Claim.supportingInfo.category, Claim.supportingInfo.code, Claim.supportingInfo.reason, Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept, Claim.diagnosis.type, Claim.diagnosis.onAdmission, Claim.diagnosis.packageCode, Claim.procedure.type, Claim.procedure.procedure[x]:procedureCodeableConcept, Claim.accident.type, Claim.item.revenue, Claim.item.category, Claim.item.productOrService, Claim.item.modifier, Claim.item.programCode, Claim.item.bodySite, Claim.item.subSite, Claim.item.detail.revenue, Claim.item.detail.category, Claim.item.detail.productOrService, Claim.item.detail.modifier, Claim.item.detail.subDetail.revenue, Claim.item.detail.subDetail.category, Claim.item.detail.subDetail.productOrService, Claim.item.detail.subDetail.modifier, Claim.item.detail.subDetail.programCode | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | Claim | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Claim | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Claim | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Claim | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Claim.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Claim.item.quantity, Claim.item.detail.quantity, Claim.item.detail.subDetail.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Claim
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron