Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Invoice_R5 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-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.

ShortInvoice containing ChargeItems from an Account
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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())
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.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.

ShortA 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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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.

ShortContained, 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.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. 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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
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 Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Invoice.status
Definition

The current state of the Invoice.

Shortdraft | issued | balanced | cancelled | entered-in-error
Control1..1
BindingThe codes SHALL be taken from InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|5.0.0
(required to http://hl7.org/fhir/ValueSet/invoice-status|5.0.0)

Codes identifying the lifecycle stage of an Invoice.

Typecode
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Invoice
2. Invoice.lineItem
4. Invoice.lineItem.priceComponent
6. Invoice.lineItem.priceComponent.extension
Control1..*
SlicingThis element introduces a set of slices on Invoice.lineItem.priceComponent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Invoice.lineItem.priceComponent.extension:type
    Slice Nametype
    Definition

    R4: Invoice.lineItem.priceComponent.type (new:code)

    ShortR4: base | surcharge | deduction | discount | tax | informational (new)
    Comments

    Element Invoice.lineItem.priceComponent.type has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.type has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control1..1
    TypeExtension(R4: base | surcharge | deduction | discount | tax | informational (new)) (Extension Type: code)
    10. Invoice.lineItem.priceComponent.extension:code
    Slice Namecode
    Definition

    R4: Invoice.lineItem.priceComponent.code (new:CodeableConcept)

    ShortR4: Code identifying the specific component (new)
    Comments

    Element Invoice.lineItem.priceComponent.code has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.code has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..1
    TypeExtension(R4: Code identifying the specific component (new)) (Extension Type: CodeableConcept)
    12. Invoice.lineItem.priceComponent.extension:factor
    Slice Namefactor
    Definition

    R4: Invoice.lineItem.priceComponent.factor (new:decimal)

    ShortR4: Factor used for calculating this component (new)
    Comments

    Element Invoice.lineItem.priceComponent.factor has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.factor has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

    Control0..1
    TypeExtension(R4: Factor used for calculating this component (new)) (Extension Type: decimal)
    14. Invoice.lineItem.priceComponent.extension:amount
    Slice Nameamount
    Definition

    R4: Invoice.lineItem.priceComponent.amount (new:Money)

    ShortR4: Monetary amount associated with this component (new)
    Comments

    Element Invoice.lineItem.priceComponent.amount has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.amount has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

    Control0..1
    TypeExtension(R4: Monetary amount associated with this component (new)) (Extension Type: Money)
    16. Invoice.totalPriceComponent
    18. Invoice.totalPriceComponent.extension
    Control0..*
    SlicingThis element introduces a set of slices on Invoice.totalPriceComponent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. Invoice.totalPriceComponent.extension:totalPriceComponent
      Slice NametotalPriceComponent
      Definition

      R4: Invoice.totalPriceComponent additional types (Invoice.lineItem.priceComponent)

      ShortR4: totalPriceComponent additional types
      Comments

      Element Invoice.totalPriceComponent is mapped to FHIR R5 element Invoice.totalPriceComponent as SourceIsBroaderThanTarget. The mappings for Invoice.totalPriceComponent do not cover the following types: Invoice.lineItem.priceComponent.

      Control0..*
      TypeExtension(R4: priceComponent) (Complex Extension)

      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.

      ShortInvoice containing ChargeItems from an Account
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.

      ShortLogical 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.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      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.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-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.

      ShortA 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.

      Control0..1
      Typeuri
      Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-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.

      ShortLanguage 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).

      Control0..1
      BindingThe codes SHALL be taken from AllLanguages
      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

      IETF language tag for a human language

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-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.

      ShortText 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.

      Control0..1
      This element is affected by the following invariants: dom-6
      TypeNarrative
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-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.

      ShortContained, 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.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline 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.

      ShortAdditional 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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Must Supportfalse
      Summarytrue
      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 Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. Invoice.identifier
      Definition

      Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

      ShortBusiness Identifier for item
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Requirements

      Allows Identification of this Invoice instance.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Invoice.status
      Definition

      The current state of the Invoice.

      Shortdraft | issued | balanced | cancelled | entered-in-error
      Control1..1
      BindingThe codes SHALL be taken from InvoiceStatus
      (required to http://hl7.org/fhir/ValueSet/invoice-status|5.0.0)

      Codes identifying the lifecycle stage of an Invoice.

      Typecode
      Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Invoice.cancelledReason
      Definition

      In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

      ShortReason 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.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Invoice.type
      Definition

      Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

      ShortType of Invoice
      Control0..1
      TypeCodeableConcept
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Alternate Namestype
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Invoice.subject
      Definition

      The individual or set of individuals receiving the goods and services billed in this invoice.

      ShortRecipient(s) of goods and services
      Control0..1
      TypeReference(Patient, Group)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Requirements

      Links the event to the Patient context.

      Alternate Namespatient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Invoice.recipient
      Definition

      The individual or Organization responsible for balancing of this invoice.

      ShortRecipient of this invoice
      Control0..1
      TypeReference(Organization, Patient, RelatedPerson)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Invoice.date
      Definition

      Depricared by the element below.

      ShortDEPRICATED
      Control0..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Requirements

      Required to suppress the Data Type VirtualServiceDetail: ERROR: Invoice::date: Expression 'Invoice.date' has illegal path.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Invoice.creation
      Definition

      Date/time(s) of when this Invoice was posted.

      ShortWhen posted
      Comments

      The list of types may be constrained as appropriate for the type of charge item.

      Control0..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Invoice.period[x]
      Definition

      Date/time(s) range of services included in this invoice.

      ShortBilling date or period
      Control0..1
      TypeChoice of: date, Period
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Invoice.participant
      Definition

      Indicates who or what performed or participated in the charged service.

      ShortParticipant in creation of this Invoice
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. 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.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      40. 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.

      ShortAdditional 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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      42. 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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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 Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      44. 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.

      ShortType of involvement in creation of this Invoice
      Control0..1
      TypeCodeableConcept
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Invoice.participant.actor
      Definition

      The device, practitioner, etc. who performed or participated in the service.

      ShortIndividual who was involved
      Control1..1
      TypeReference(Practitioner, Organization, Patient, PractitionerRole, Device, RelatedPerson)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Invoice.issuer
      Definition

      The organizationissuing the Invoice.

      ShortIssuing Organization of Invoice
      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.

      Control0..1
      TypeReference(Organization)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Invoice.account
      Definition

      Account which is supposed to be balanced with this Invoice.

      ShortAccount 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.

      Control0..1
      TypeReference(Account)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. 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.

      ShortLine items of this Invoice
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. 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.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      56. 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.

      ShortAdditional 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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      58. 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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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 Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      60. Invoice.lineItem.sequence
      Definition

      Sequence in which the items appear on the invoice.

      ShortSequence number of line item
      Control0..1
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. Invoice.lineItem.serviced[x]
      Definition

      Date/time(s) range when this service was delivered or completed.

      ShortService data or period
      Control0..1
      TypeChoice of: date, Period
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. 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.

      ShortReference to ChargeItem containing details of this line item or an inline billing code
      Control1..1
      TypeChoice of: Reference(ChargeItem), CodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. 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.

      ShortComponents of total line item price
      Control0..*
      TypeMonetaryComponent
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. Invoice.lineItem.priceComponent.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      70. Invoice.lineItem.priceComponent.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Invoice.lineItem.priceComponent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 72. Invoice.lineItem.priceComponent.extension:type
        Slice Nametype
        Definition

        R4: Invoice.lineItem.priceComponent.type (new:code)

        ShortR4: base | surcharge | deduction | discount | tax | informational (new)
        Comments

        Element Invoice.lineItem.priceComponent.type has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.type has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control1..1
        TypeExtension(R4: base | surcharge | deduction | discount | tax | informational (new)) (Extension Type: code)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        74. Invoice.lineItem.priceComponent.extension:code
        Slice Namecode
        Definition

        R4: Invoice.lineItem.priceComponent.code (new:CodeableConcept)

        ShortR4: Code identifying the specific component (new)
        Comments

        Element Invoice.lineItem.priceComponent.code has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.code has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(R4: Code identifying the specific component (new)) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        76. Invoice.lineItem.priceComponent.extension:factor
        Slice Namefactor
        Definition

        R4: Invoice.lineItem.priceComponent.factor (new:decimal)

        ShortR4: Factor used for calculating this component (new)
        Comments

        Element Invoice.lineItem.priceComponent.factor has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.factor has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

        Control0..1
        TypeExtension(R4: Factor used for calculating this component (new)) (Extension Type: decimal)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        78. Invoice.lineItem.priceComponent.extension:amount
        Slice Nameamount
        Definition

        R4: Invoice.lineItem.priceComponent.amount (new:Money)

        ShortR4: Monetary amount associated with this component (new)
        Comments

        Element Invoice.lineItem.priceComponent.amount has a context of Invoice.lineItem.priceComponent based on following the parent source element upwards and mapping to Invoice. Element Invoice.lineItem.priceComponent.amount has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

        Control0..1
        TypeExtension(R4: Monetary amount associated with this component (new)) (Extension Type: Money)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        80. Invoice.lineItem.priceComponent.type
        Definition

        base | surcharge | deduction | discount | tax | informational.

        Shortbase | surcharge | deduction | discount | tax | informational
        Control1..1
        BindingThe codes SHALL be taken from PriceComponentType
        (required to http://hl7.org/fhir/ValueSet/price-component-type|5.0.0)

        The purpose for which an extended contact detail should be used.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. Invoice.lineItem.priceComponent.code
        Definition

        Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

        ShortCodes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
        Control0..1
        Binding

        Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Invoice.lineItem.priceComponent.factor
        Definition

        Factor used for calculating this component.

        ShortFactor used for calculating this component
        Control0..1
        Typedecimal
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. Invoice.lineItem.priceComponent.amount
        Definition

        Explicit value amount to be used.

        ShortExplicit value amount to be used
        Control0..1
        TypeMoney
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        88. 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.

        ShortComponents of Invoice total
        Control0..*
        TypeMonetaryComponent
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        90. Invoice.totalPriceComponent.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeid
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        92. Invoice.totalPriceComponent.extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Invoice.totalPriceComponent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 94. Invoice.totalPriceComponent.extension:totalPriceComponent
          Slice NametotalPriceComponent
          Definition

          R4: Invoice.totalPriceComponent additional types (Invoice.lineItem.priceComponent)

          ShortR4: totalPriceComponent additional types
          Comments

          Element Invoice.totalPriceComponent is mapped to FHIR R5 element Invoice.totalPriceComponent as SourceIsBroaderThanTarget. The mappings for Invoice.totalPriceComponent do not cover the following types: Invoice.lineItem.priceComponent.

          Control0..*
          TypeExtension(R4: priceComponent) (Complex Extension)
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          96. Invoice.totalPriceComponent.type
          Definition

          base | surcharge | deduction | discount | tax | informational.

          Shortbase | surcharge | deduction | discount | tax | informational
          Control1..1
          BindingThe codes SHALL be taken from PriceComponentType
          (required to http://hl7.org/fhir/ValueSet/price-component-type|5.0.0)

          The purpose for which an extended contact detail should be used.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          98. Invoice.totalPriceComponent.code
          Definition

          Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

          ShortCodes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
          Control0..1
          Binding

          Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          100. Invoice.totalPriceComponent.factor
          Definition

          Factor used for calculating this component.

          ShortFactor used for calculating this component
          Control0..1
          Typedecimal
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          102. Invoice.totalPriceComponent.amount
          Definition

          Explicit value amount to be used.

          ShortExplicit value amount to be used
          Control0..1
          TypeMoney
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          104. Invoice.totalNet
          Definition

          Invoice total , taxes excluded.

          ShortNet 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.

          Control0..1
          TypeMoney
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          106. Invoice.totalGross
          Definition

          Invoice total, tax included.

          ShortGross 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.

          Control0..1
          TypeMoney
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          108. Invoice.paymentTerms
          Definition

          Payment details such as banking details, period of payment, deductibles, methods of payment.

          ShortPayment details
          Comments

          Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

          Control0..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          110. Invoice.note
          Definition

          Comments made about the invoice by the issuer, subject, or other participants.

          ShortComments made about the invoice
          Control0..*
          TypeAnnotation
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))