FHIR Implementation Guide for ABDM
6.0.0 - active
FHIR Implementation Guide for ABDM
6.0.0 - active
This page is part of the FHIR Implementation Guide for ABDM (v6.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/ChargeItem | Version: 6.0.0 | |||
| Draft as of 2024-01-24 | Computable Name: ChargeItem | |||
This profile sets the minimum expectations for the ChargeItem resource in order to store various details about the items under invoice which are being charged.
ChargeItem resource defines the details regarding the services, medications or medicinal devices provided during an encounter or visit for a patient. It’s mainly to be used to provide additional info such as date, times, amounts and participating organizations if any.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChargeItem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
  partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |
  code | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) | |
 coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 1..1 | Reference(Group | Patient) | Individual service was done for/to | |
| context | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event | |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When the charged service was applied |
| performer | ||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization) | Individual who was performing | |
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |
| quantity | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. | |
| enterer | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering | |
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |
  product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. | ||
 productReference | Reference(Device | Substance | Medication) | |||
 productCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. |
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | Patient) | Individual service was done for/to |
| context | Σ | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event |
| occurrence[x] | SΣ | 0..1 | When the charged service was applied | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. |
| enterer | Σ | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering |
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |
| product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. Binding: FHIRDeviceTypes (example): Example binding for product type. | ||
| productReference | Reference(Device | Substance | Medication) | |||
| productCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ChargeItem.status | required | ChargeItemStatushttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1from the FHIR Standard | |
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG | |
| ChargeItem.product[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ChargeItem | 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 | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for item | ||||
| definitionUri | 0..* | uri | Defining information about the code of this charge item | |||||
| definitionCanonical | 0..* | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |||||
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. | ||||
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |||||
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Group | Patient) | Individual service was done for/to | ||||
| context | Σ | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event | ||||
| occurrence[x] | SΣ | 0..1 | When the charged service was applied | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| performer | 0..* | BackboneElement | Who performed charged service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events. | |||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization) | Individual who was performing | |||||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |||||
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |||||
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |||||
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. | ||||
| bodysite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| factorOverride | 0..1 | decimal | Factor overriding the associated rules | |||||
| priceOverride | 0..1 | Money | Price overriding the associated rules | |||||
| overrideReason | 0..1 | string | Reason for overriding the list price/factor | |||||
| enterer | Σ | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering | ||||
| enteredDate | Σ | 0..1 | dateTime | Date the charge item was entered | ||||
| reason | 0..* | CodeableConcept | Why was the charged service rendered? Binding: ICD-10Codes (example): Example binding for reason. | |||||
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |||||
| product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. Binding: FHIRDeviceTypes (example): Example binding for product type. | ||||||
| productReference | Reference(Device | Substance | Medication) | |||||||
| productCodeableConcept | CodeableConcept | |||||||
| account | Σ | 0..* | Reference(Account) | Account to place this charge | ||||
| note | 0..* | Annotation | Comments made about the ChargeItem | |||||
| supportingInformation | 0..* | Reference(Resource) | Further information supporting this charge | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ChargeItem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ChargeItem.status | required | ChargeItemStatushttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1from the FHIR Standard | ||||
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG | ||||
| ChargeItem.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| ChargeItem.bodysite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ChargeItem.reason | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10from the FHIR Standard | ||||
| ChargeItem.product[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ChargeItem | 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 | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | 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 ChargeItem
Summary
Mandatory: 6 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ChargeItem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |
| code | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 1..1 | Reference(Group | Patient) | Individual service was done for/to | |
| context | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event | |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When the charged service was applied |
| performer | ||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization) | Individual who was performing | |
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |
| quantity | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. | |
| enterer | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering | |
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |
| product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. | ||
| productReference | Reference(Device | Substance | Medication) | |||
| productCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. |
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | Patient) | Individual service was done for/to |
| context | Σ | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event |
| occurrence[x] | SΣ | 0..1 | When the charged service was applied | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. |
| enterer | Σ | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering |
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |
| product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. Binding: FHIRDeviceTypes (example): Example binding for product type. | ||
| productReference | Reference(Device | Substance | Medication) | |||
| productCodeableConcept | CodeableConcept | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ChargeItem.status | required | ChargeItemStatushttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1from the FHIR Standard | |
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG | |
| ChargeItem.product[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ChargeItem | 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 | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ChargeItem | 0..* | ChargeItem | Item containing charge code(s) associated with the provision of healthcare provider products | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for item | ||||
| definitionUri | 0..* | uri | Defining information about the code of this charge item | |||||
| definitionCanonical | 0..* | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | |||||
| status | ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem. | ||||
| partOf | 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | |||||
| code | Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: ChargeItem Types (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Group | Patient) | Individual service was done for/to | ||||
| context | Σ | 0..1 | Reference(EpisodeOfCare | Encounter) | Encounter / Episode associated with event | ||||
| occurrence[x] | SΣ | 0..1 | When the charged service was applied | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| performer | 0..* | BackboneElement | Who performed charged service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | 0..1 | CodeableConcept | What type of performance was done Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events. | |||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization) | Individual who was performing | |||||
| performingOrganization | 0..1 | Reference(Organization) | Organization providing the charged service | |||||
| requestingOrganization | 0..1 | Reference(Organization) | Organization requesting the charged service | |||||
| costCenter | 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | |||||
| quantity | Σ | 1..1 | Quantity | Quantity of which the charge item has been serviced. Indicates the total quantity of medicines or medical devices bought. | ||||
| bodysite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| factorOverride | 0..1 | decimal | Factor overriding the associated rules | |||||
| priceOverride | 0..1 | Money | Price overriding the associated rules | |||||
| overrideReason | 0..1 | string | Reason for overriding the list price/factor | |||||
| enterer | Σ | 0..1 | Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Individual who was entering | ||||
| enteredDate | Σ | 0..1 | dateTime | Date the charge item was entered | ||||
| reason | 0..* | CodeableConcept | Why was the charged service rendered? Binding: ICD-10Codes (example): Example binding for reason. | |||||
| service | 0..* | Reference(DiagnosticReport | MedicationAdministration | MedicationDispense | SupplyDelivery | ImagingStudy | Immunization | Observation | Procedure) | Which rendered service is being charged? | |||||
| product[x] | 1..1 | Product charged. In case of invoice for pharmacy the medication resource will be populated containing the relevant details for the medicines mentioned in the prescription. For other cases of invoice such as for consultation, in patient details the codeableconcept must be populated. Binding: FHIRDeviceTypes (example): Example binding for product type. | ||||||
| productReference | Reference(Device | Substance | Medication) | |||||||
| productCodeableConcept | CodeableConcept | |||||||
| account | Σ | 0..* | Reference(Account) | Account to place this charge | ||||
| note | 0..* | Annotation | Comments made about the ChargeItem | |||||
| supportingInformation | 0..* | Reference(Resource) | Further information supporting this charge | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ChargeItem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ChargeItem.status | required | ChargeItemStatushttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1from the FHIR Standard | ||||
| ChargeItem.code | extensible | ChargeItemTypes (a valid code from Billing Codes)https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-chargeitem-typesfrom this IG | ||||
| ChargeItem.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| ChargeItem.bodysite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ChargeItem.reason | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10from the FHIR Standard | ||||
| ChargeItem.product[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ChargeItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ChargeItem | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ChargeItem | 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 | ChargeItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ChargeItem | 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 ChargeItem
Summary
Mandatory: 6 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron