FHIR R6 FM Incubator, published by HL7 International / Financial Management. 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/HL7/fm-incubator/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the Invoice resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | |
| Definition | Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. A resource that includes narrative, extensions, and contained resources. |
| Short | Invoice containing ChargeItems from an AccountA resource with narrative, extensions, and contained resources |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. Invoice.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Invoice.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Invoice.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Invoice.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3 (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Invoice.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Invoice.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. Invoice.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Invoice.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Invoice.identifier | |
| Definition | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
| Short | Business Identifier for item |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Summary | true |
| Requirements | Allows Identification of this Invoice instance. |
| 20. Invoice.status | |
| Definition | The current state of the Invoice. |
| Short | draft | issued | balanced | cancelled | entered-in-error |
| Control | 1..1 |
| Binding | The codes SHALL be taken from InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status (required to http://hl7.org/fhir/ValueSet/invoice-status)Codes identifying the lifecycle stage of an Invoice. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. Invoice.cancelledReason | |
| Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). |
| Short | Reason for cancellation of this Invoice |
| Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 24. Invoice.type | |
| Definition | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
| Short | Type of Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| Summary | true |
| Alternate Names | type |
| 26. Invoice.subject | |
| Definition | The individual or set of individuals receiving the goods and services billed in this invoice. |
| Short | Recipient(s) of goods and services |
| Control | 0..1 |
| Type | Reference(Patient, Group) |
| Summary | true |
| Requirements | Links the event to the Patient context. |
| Alternate Names | patient |
| 28. Invoice.recipient | |
| Definition | The individual or Organization responsible for balancing of this invoice. |
| Short | Recipient of this invoice |
| Control | 0..1 |
| Type | Reference(Organization, Patient, RelatedPerson) |
| Summary | true |
| 30. Invoice.creation | |
| Definition | Date/time(s) of when this Invoice was posted. |
| Short | When posted |
| Comments | The list of types may be constrained as appropriate for the type of charge item. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 32. Invoice.period[x] | |
| Definition | Date/time(s) range of services included in this invoice. |
| Short | Billing date or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. Invoice.participant | |
| Definition | Indicates who or what performed or participated in the charged service. |
| Short | Participant in creation of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count())) |
| 36. Invoice.participant.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | idstring |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 38. Invoice.participant.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. Invoice.participant.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Invoice.participant.role | |
| Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
| Short | Type of involvement in creation of this Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| Summary | false |
| 44. Invoice.participant.actor | |
| Definition | The device, practitioner, etc. who performed or participated in the service. |
| Short | Individual who was involved |
| Control | 1..1 |
| Type | Reference(Practitioner, Organization, Patient, PractitionerRole, Device, RelatedPerson) |
| Summary | false |
| 46. Invoice.issuer | |
| Definition | The organizationissuing the Invoice. |
| Short | Issuing entity |
| Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. |
| Control | 0..1 |
| Type | Reference(Organization, Practitioner, PractitionerRole) |
| Summary | false |
| 48. Invoice.account | |
| Definition | Account which is supposed to be balanced with this Invoice. |
| Short | Account that is being balanced |
| Comments | Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate. |
| Control | 0..1 |
| Type | Reference(Account) |
| Summary | false |
| 50. Invoice.lineItem | |
| Definition | Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource. |
| Short | Line items of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count())) |
| 52. Invoice.lineItem.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | idstring |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 54. Invoice.lineItem.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.lineItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. Invoice.lineItem.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Invoice.lineItem.sequence | |
| Definition | Sequence in which the items appear on the invoice. |
| Short | Sequence number of line item |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 60. Invoice.lineItem.serviced[x] | |
| Definition | Date/time(s) range when this service was delivered or completed. |
| Short | Service data or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 62. Invoice.lineItem.chargeItem[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
| Short | Reference to ChargeItem containing details of this line item or an inline billing code |
| Control | 1..1 |
| Type | Choice of: Reference, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Summary | false |
| 64. Invoice.lineItem.priceComponent | |
| Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. |
| Short | Components of total line item price |
| Control | 0..* |
| Type | MonetaryComponent |
| Summary | false |
| 66. Invoice.totalPriceComponent | |
| Definition | The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated. |
| Short | Components of Invoice total |
| Control | 0..* |
| Type | MonetaryComponent |
| Summary | false |
| 68. Invoice.totalNet | |
| Definition | Invoice total , taxes excluded. |
| Short | Net total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| 70. Invoice.totalGross | |
| Definition | Invoice total, tax included. |
| Short | Gross total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| 72. Invoice.paymentTerms | |
| Definition | Payment details such as banking details, period of payment, deductibles, methods of payment. |
| Short | Payment details |
| Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 74. Invoice.note | |
| Definition | Comments made about the invoice by the issuer, subject, or other participants. |
| Short | Comments made about the invoice |
| Control | 0..* |
| Type | Annotation |
| Summary | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | |
| Definition | Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. |
| Short | Invoice containing ChargeItems from an Account |
| Control | 0..* |
| 2. Invoice.identifier | |
| Definition | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
| Short | Business Identifier for item |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Requirements | Allows Identification of this Invoice instance. |
| 4. Invoice.status | |
| Definition | The current state of the Invoice. |
| Short | draft | issued | balanced | cancelled | entered-in-error |
| Control | 1..1 |
| Binding | The codes SHALL be taken from InvoiceStatus (required to http://hl7.org/fhir/ValueSet/invoice-status)Codes identifying the lifecycle stage of an Invoice. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. Invoice.cancelledReason | |
| Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). |
| Short | Reason for cancellation of this Invoice |
| Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. Invoice.type | |
| Definition | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
| Short | Type of Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| Alternate Names | type |
| 10. Invoice.subject | |
| Definition | The individual or set of individuals receiving the goods and services billed in this invoice. |
| Short | Recipient(s) of goods and services |
| Control | 0..1 |
| Type | Reference(Patient, Group) |
| Requirements | Links the event to the Patient context. |
| Alternate Names | patient |
| 12. Invoice.recipient | |
| Definition | The individual or Organization responsible for balancing of this invoice. |
| Short | Recipient of this invoice |
| Control | 0..1 |
| Type | Reference(Organization, Patient, RelatedPerson) |
| 14. Invoice.creation | |
| Definition | Date/time(s) of when this Invoice was posted. |
| Short | When posted |
| Comments | The list of types may be constrained as appropriate for the type of charge item. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Invoice.period[x] | |
| Definition | Date/time(s) range of services included in this invoice. |
| Short | Billing date or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. Invoice.participant | |
| Definition | Indicates who or what performed or participated in the charged service. |
| Short | Participant in creation of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| 20. Invoice.participant.role | |
| Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
| Short | Type of involvement in creation of this Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| 22. Invoice.participant.actor | |
| Definition | The device, practitioner, etc. who performed or participated in the service. |
| Short | Individual who was involved |
| Control | 1..1 |
| Type | Reference(Practitioner, Organization, Patient, PractitionerRole, Device, RelatedPerson) |
| 24. Invoice.issuer | |
| Definition | The organizationissuing the Invoice. |
| Short | Issuing entity |
| Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. |
| Control | 0..1 |
| Type | Reference(Organization, Practitioner, PractitionerRole) |
| 26. Invoice.account | |
| Definition | Account which is supposed to be balanced with this Invoice. |
| Short | Account that is being balanced |
| Comments | Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate. |
| Control | 0..1 |
| Type | Reference(Account) |
| 28. Invoice.lineItem | |
| Definition | Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource. |
| Short | Line items of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| 30. Invoice.lineItem.sequence | |
| Definition | Sequence in which the items appear on the invoice. |
| Short | Sequence number of line item |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Invoice.lineItem.serviced[x] | |
| Definition | Date/time(s) range when this service was delivered or completed. |
| Short | Service data or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Invoice.lineItem.chargeItem[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
| Short | Reference to ChargeItem containing details of this line item or an inline billing code |
| Control | 1..1 |
| Type | Choice of: Reference, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 36. Invoice.lineItem.priceComponent | |
| Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. |
| Short | Components of total line item price |
| Control | 0..* |
| Type | MonetaryComponent |
| 38. Invoice.totalPriceComponent | |
| Definition | The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated. |
| Short | Components of Invoice total |
| Control | 0..* |
| Type | MonetaryComponent |
| 40. Invoice.totalNet | |
| Definition | Invoice total , taxes excluded. |
| Short | Net total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| 42. Invoice.totalGross | |
| Definition | Invoice total, tax included. |
| Short | Gross total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| 44. Invoice.paymentTerms | |
| Definition | Payment details such as banking details, period of payment, deductibles, methods of payment. |
| Short | Payment details |
| Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 46. Invoice.note | |
| Definition | Comments made about the invoice by the issuer, subject, or other participants. |
| Short | Comments made about the invoice |
| Control | 0..* |
| Type | Annotation |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | |
| Definition | Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. |
| Short | Invoice containing ChargeItems from an Account |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) |
| 2. Invoice.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Invoice.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Invoice.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Invoice.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Invoice.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Invoice.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. Invoice.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Invoice.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Invoice.identifier | |
| Definition | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
| Short | Business Identifier for item |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Summary | true |
| Requirements | Allows Identification of this Invoice instance. |
| 20. Invoice.status | |
| Definition | The current state of the Invoice. |
| Short | draft | issued | balanced | cancelled | entered-in-error |
| Control | 1..1 |
| Binding | The codes SHALL be taken from InvoiceStatus (required to http://hl7.org/fhir/ValueSet/invoice-status)Codes identifying the lifecycle stage of an Invoice. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. Invoice.cancelledReason | |
| Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). |
| Short | Reason for cancellation of this Invoice |
| Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 24. Invoice.type | |
| Definition | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
| Short | Type of Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| Summary | true |
| Alternate Names | type |
| 26. Invoice.subject | |
| Definition | The individual or set of individuals receiving the goods and services billed in this invoice. |
| Short | Recipient(s) of goods and services |
| Control | 0..1 |
| Type | Reference(Patient, Group) |
| Summary | true |
| Requirements | Links the event to the Patient context. |
| Alternate Names | patient |
| 28. Invoice.recipient | |
| Definition | The individual or Organization responsible for balancing of this invoice. |
| Short | Recipient of this invoice |
| Control | 0..1 |
| Type | Reference(Organization, Patient, RelatedPerson) |
| Summary | true |
| 30. Invoice.creation | |
| Definition | Date/time(s) of when this Invoice was posted. |
| Short | When posted |
| Comments | The list of types may be constrained as appropriate for the type of charge item. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 32. Invoice.period[x] | |
| Definition | Date/time(s) range of services included in this invoice. |
| Short | Billing date or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. Invoice.participant | |
| Definition | Indicates who or what performed or participated in the charged service. |
| Short | Participant in creation of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count())) |
| 36. Invoice.participant.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 38. Invoice.participant.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. Invoice.participant.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Invoice.participant.role | |
| Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
| Short | Type of involvement in creation of this Invoice |
| Control | 0..1 |
| Type | CodeableConcept |
| Summary | false |
| 44. Invoice.participant.actor | |
| Definition | The device, practitioner, etc. who performed or participated in the service. |
| Short | Individual who was involved |
| Control | 1..1 |
| Type | Reference(Practitioner, Organization, Patient, PractitionerRole, Device, RelatedPerson) |
| Summary | false |
| 46. Invoice.issuer | |
| Definition | The organizationissuing the Invoice. |
| Short | Issuing entity |
| Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. |
| Control | 0..1 |
| Type | Reference(Organization, Practitioner, PractitionerRole) |
| Summary | false |
| 48. Invoice.account | |
| Definition | Account which is supposed to be balanced with this Invoice. |
| Short | Account that is being balanced |
| Comments | Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate. |
| Control | 0..1 |
| Type | Reference(Account) |
| Summary | false |
| 50. Invoice.lineItem | |
| Definition | Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource. |
| Short | Line items of this Invoice |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count())) |
| 52. Invoice.lineItem.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 54. Invoice.lineItem.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Invoice.lineItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. Invoice.lineItem.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Invoice.lineItem.sequence | |
| Definition | Sequence in which the items appear on the invoice. |
| Short | Sequence number of line item |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 60. Invoice.lineItem.serviced[x] | |
| Definition | Date/time(s) range when this service was delivered or completed. |
| Short | Service data or period |
| Control | 0..1 |
| Type | Choice of: date, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 62. Invoice.lineItem.chargeItem[x] | |
| Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
| Short | Reference to ChargeItem containing details of this line item or an inline billing code |
| Control | 1..1 |
| Type | Choice of: Reference, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Summary | false |
| 64. Invoice.lineItem.priceComponent | |
| Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. |
| Short | Components of total line item price |
| Control | 0..* |
| Type | MonetaryComponent |
| Summary | false |
| 66. Invoice.totalPriceComponent | |
| Definition | The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated. |
| Short | Components of Invoice total |
| Control | 0..* |
| Type | MonetaryComponent |
| Summary | false |
| 68. Invoice.totalNet | |
| Definition | Invoice total , taxes excluded. |
| Short | Net total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| 70. Invoice.totalGross | |
| Definition | Invoice total, tax included. |
| Short | Gross total of this Invoice |
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. |
| Control | 0..1 |
| Type | Money |
| Summary | true |
| 72. Invoice.paymentTerms | |
| Definition | Payment details such as banking details, period of payment, deductibles, methods of payment. |
| Short | Payment details |
| Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| 74. Invoice.note | |
| Definition | Comments made about the invoice by the issuer, subject, or other participants. |
| Short | Comments made about the invoice |
| Control | 0..* |
| Type | Annotation |
| Summary | false |