Personal Health Records
1.0.0-ballot2 - STU 1 ballot International flag

Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions

Logical Model: Financial Receipt - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the FinancialReceipt logical model

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

0. FinancialReceipt
Definition

A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource.

ShortFinancial Receipt
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. FinancialReceipt.subject
Definition

The patient or person that purchased the item

ShortThe patient or person that purchased the item
Control1..1
TypeReference(Patient)
4. FinancialReceipt.date
Definition

The date of the transaction

ShortThe date of the transaction
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. FinancialReceipt.vendor
Definition

Vendor or merchant name

ShortVendor or merchant name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. FinancialReceipt.category
Definition

Category of expense (e.g. pharmacy, medical supply, copay, wellness)

ShortCategory of expense (e.g. pharmacy, medical supply, copay, wellness)
Control0..1
TypeCodeableConcept
10. FinancialReceipt.item
Definition

Line items on the receipt

ShortLine items on the receipt
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. FinancialReceipt.item.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
14. FinancialReceipt.item.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 manageable, 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())
SlicingThis element introduces a set of slices on FinancialReceipt.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. FinancialReceipt.item.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 manageable, 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())
    18. FinancialReceipt.item.description
    Definition

    Item description

    ShortItem description
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. FinancialReceipt.item.quantity
    Definition

    Quantity purchased

    ShortQuantity purchased
    Control0..1
    TypeQuantity(SimpleQuantity)
    22. FinancialReceipt.item.unitPrice
    Definition

    Price per unit

    ShortPrice per unit
    Control0..1
    TypeMoney
    24. FinancialReceipt.item.amount
    Definition

    Line item total

    ShortLine item total
    Control0..1
    TypeMoney
    26. FinancialReceipt.subtotal
    Definition

    Subtotal before tax

    ShortSubtotal before tax
    Control0..1
    TypeMoney
    28. FinancialReceipt.taxAmount
    Definition

    Tax amount

    ShortTax amount
    Control0..1
    TypeMoney
    30. FinancialReceipt.total
    Definition

    Total amount paid

    ShortTotal amount paid
    Control1..1
    TypeMoney
    32. FinancialReceipt.paymentMethod
    Definition

    Payment method (e.g. cash, credit, debit, HSA, FSA)

    ShortPayment method (e.g. cash, credit, debit, HSA, FSA)
    Control0..1
    TypeCodeableConcept
    34. FinancialReceipt.relatedClaim
    Definition

    Related insurance claim, if any

    ShortRelated insurance claim, if any
    Control0..1
    TypeReference(Claim)

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

    0. FinancialReceipt
    Definition

    A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource.

    ShortFinancial Receipt
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. FinancialReceipt.subject
    Definition

    The patient or person that purchased the item

    ShortThe patient or person that purchased the item
    Control1..1
    TypeReference(Patient)
    4. FinancialReceipt.date
    Definition

    The date of the transaction

    ShortThe date of the transaction
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. FinancialReceipt.vendor
    Definition

    Vendor or merchant name

    ShortVendor or merchant name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. FinancialReceipt.category
    Definition

    Category of expense (e.g. pharmacy, medical supply, copay, wellness)

    ShortCategory of expense (e.g. pharmacy, medical supply, copay, wellness)
    Control0..1
    TypeCodeableConcept
    10. FinancialReceipt.item
    Definition

    Line items on the receipt

    ShortLine items on the receipt
    Control0..*
    TypeBackboneElement
    12. FinancialReceipt.item.description
    Definition

    Item description

    ShortItem description
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. FinancialReceipt.item.quantity
    Definition

    Quantity purchased

    ShortQuantity purchased
    Control0..1
    TypeQuantity(SimpleQuantity)
    16. FinancialReceipt.item.unitPrice
    Definition

    Price per unit

    ShortPrice per unit
    Control0..1
    TypeMoney
    18. FinancialReceipt.item.amount
    Definition

    Line item total

    ShortLine item total
    Control0..1
    TypeMoney
    20. FinancialReceipt.subtotal
    Definition

    Subtotal before tax

    ShortSubtotal before tax
    Control0..1
    TypeMoney
    22. FinancialReceipt.taxAmount
    Definition

    Tax amount

    ShortTax amount
    Control0..1
    TypeMoney
    24. FinancialReceipt.total
    Definition

    Total amount paid

    ShortTotal amount paid
    Control1..1
    TypeMoney
    26. FinancialReceipt.paymentMethod
    Definition

    Payment method (e.g. cash, credit, debit, HSA, FSA)

    ShortPayment method (e.g. cash, credit, debit, HSA, FSA)
    Control0..1
    TypeCodeableConcept
    28. FinancialReceipt.relatedClaim
    Definition

    Related insurance claim, if any

    ShortRelated insurance claim, if any
    Control0..1
    TypeReference(Claim)

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

    0. FinancialReceipt
    Definition

    A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource.

    ShortFinancial Receipt
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. FinancialReceipt.subject
    Definition

    The patient or person that purchased the item

    ShortThe patient or person that purchased the item
    Control1..1
    TypeReference(Patient)
    4. FinancialReceipt.date
    Definition

    The date of the transaction

    ShortThe date of the transaction
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. FinancialReceipt.vendor
    Definition

    Vendor or merchant name

    ShortVendor or merchant name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. FinancialReceipt.category
    Definition

    Category of expense (e.g. pharmacy, medical supply, copay, wellness)

    ShortCategory of expense (e.g. pharmacy, medical supply, copay, wellness)
    Control0..1
    TypeCodeableConcept
    10. FinancialReceipt.item
    Definition

    Line items on the receipt

    ShortLine items on the receipt
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. FinancialReceipt.item.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
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    14. FinancialReceipt.item.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 manageable, 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())
    SlicingThis element introduces a set of slices on FinancialReceipt.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. FinancialReceipt.item.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 manageable, 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())
      18. FinancialReceipt.item.description
      Definition

      Item description

      ShortItem description
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      20. FinancialReceipt.item.quantity
      Definition

      Quantity purchased

      ShortQuantity purchased
      Control0..1
      TypeQuantity(SimpleQuantity)
      22. FinancialReceipt.item.unitPrice
      Definition

      Price per unit

      ShortPrice per unit
      Control0..1
      TypeMoney
      24. FinancialReceipt.item.amount
      Definition

      Line item total

      ShortLine item total
      Control0..1
      TypeMoney
      26. FinancialReceipt.subtotal
      Definition

      Subtotal before tax

      ShortSubtotal before tax
      Control0..1
      TypeMoney
      28. FinancialReceipt.taxAmount
      Definition

      Tax amount

      ShortTax amount
      Control0..1
      TypeMoney
      30. FinancialReceipt.total
      Definition

      Total amount paid

      ShortTotal amount paid
      Control1..1
      TypeMoney
      32. FinancialReceipt.paymentMethod
      Definition

      Payment method (e.g. cash, credit, debit, HSA, FSA)

      ShortPayment method (e.g. cash, credit, debit, HSA, FSA)
      Control0..1
      TypeCodeableConcept
      34. FinancialReceipt.relatedClaim
      Definition

      Related insurance claim, if any

      ShortRelated insurance claim, if any
      Control0..1
      TypeReference(Claim)