FHIR Implementation Guide for ABDM
7.0.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v7.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Invoice

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Invoice Version: 7.0.0
Draft as of 2025-03-18 Computable Name: Invoice

This profile sets the minimum expectations for the details to be added in order to generate invoices for various healthcare process or workflows.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... text SΣ 0..1 string Plain text representation of the concept
.... value Σ 1..1 string The value that is unique (example the invoice number or bill number)
Example General: 123456
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type Σ 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(RelatedPerson | Patient | Organization) Recipient of this invoice
... date Σ 1..1 dateTime Invoice date / posting date
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... lineItem 1..* BackboneElement Line items of this Invoice
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... amount 1..1 Money Monetary amount associated with this component
... totalNet Σ 1..1 Money Net total of this Invoice
... totalGross Σ 1..1 Money Gross total of this Invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Invoice.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice 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 Invoice 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 Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice 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 Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... identifier 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... type
..... text S 0..1 string Plain text representation of the concept
.... value 1..1 string The value that is unique (example the invoice number or bill number)
.... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... type 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... date 1..1 dateTime Invoice date / posting date
... participant
.... actor 1..1 Reference(Device | RelatedPerson | Practitioner | Organization | Patient | PractitionerRole) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... lineItem 1..* BackboneElement Line items of this Invoice
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... amount 1..1 Money Monetary amount associated with this component
... totalNet 1..1 Money Net total of this Invoice
... totalGross 1..1 Money Gross total of this Invoice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... 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
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... 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 Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique (example the invoice number or bill number)
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(RelatedPerson | Patient | Organization) Recipient of this invoice
... date Σ 1..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... 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
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Device | RelatedPerson | Practitioner | Organization | Patient | PractitionerRole) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 1..* BackboneElement Line items of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... factor 0..1 decimal Factor used for calculating this component
..... amount 1..1 Money Monetary amount associated with this component
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 1..1 Money Net total of this Invoice
... totalGross Σ 1..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Invoice.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Invoice.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice 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 Invoice 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 Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... text SΣ 0..1 string Plain text representation of the concept
.... value Σ 1..1 string The value that is unique (example the invoice number or bill number)
Example General: 123456
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type Σ 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(RelatedPerson | Patient | Organization) Recipient of this invoice
... date Σ 1..1 dateTime Invoice date / posting date
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... lineItem 1..* BackboneElement Line items of this Invoice
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... amount 1..1 Money Monetary amount associated with this component
... totalNet Σ 1..1 Money Net total of this Invoice
... totalGross Σ 1..1 Money Gross total of this Invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Invoice.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice 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 Invoice 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 Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice 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 Invoice

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... identifier 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... type
..... text S 0..1 string Plain text representation of the concept
.... value 1..1 string The value that is unique (example the invoice number or bill number)
.... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... type 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... date 1..1 dateTime Invoice date / posting date
... participant
.... actor 1..1 Reference(Device | RelatedPerson | Practitioner | Organization | Patient | PractitionerRole) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... lineItem 1..* BackboneElement Line items of this Invoice
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... amount 1..1 Money Monetary amount associated with this component
... totalNet 1..1 Money Net total of this Invoice
... totalGross 1..1 Money Gross total of this Invoice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* Invoice Invoice containing ChargeItems from an Account
... 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
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business Identifier for invoice (e.g invoice number or bill number)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... 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 Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique (example the invoice number or bill number)
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 1..1 CodeableConcept Type of Invoice
Binding: Invoice Type (extensible): Valueset for invoice types
.... 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) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(RelatedPerson | Patient | Organization) Recipient of this invoice
... date Σ 1..1 dateTime Invoice date / posting date
... participant 0..* BackboneElement Participant in creation of this Invoice
.... 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
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Device | RelatedPerson | Practitioner | Organization | Patient | PractitionerRole) Individual who was involved
... issuer 0..1 Reference(Organization) Issuing Organization of Invoice
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 1..* BackboneElement Line items of this Invoice
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. In the context of ABDM the Chargeitem resource reference must be populated indicating the details for the medicines or other service charged.
..... chargeItemReference Reference(ChargeItem)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 1..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 1..1 CodeableConcept Code identifying the specific component
Binding: Price Component (extensible): Price components
...... 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
..... factor 0..1 decimal Factor used for calculating this component
..... amount 1..1 Money Monetary amount associated with this component
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 1..1 Money Net total of this Invoice
... totalGross Σ 1..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Invoice.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Invoice.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Invoice.status Base required InvoiceStatus 📍4.0.1 FHIR Std.
Invoice.type Base extensible Invoice Type 📦7.0.0 This IG
Invoice.lineItem.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.
Invoice.lineItem.priceComponent.​code Base extensible Price Component 📦7.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice 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 Invoice 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 Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice 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()

 

Other representations of profile: CSV, Excel, Schematron