Invoice - FHIR Resource (r4)

This Invoice Resource uses the FHIR API standard for access and structure.

Validate an Invoice FHIR Resource (r4)

Validate this Invoice

Resource Attributes

Attribute	Field is list	Type	Description
account	false	Reference	# Account that is being balanced
cancelledReason	false	string	# Reason for cancellation of this Invoice
date	false	dateTime	# Invoice date / posting date
identifier	true	Identifier	# Business Identifier for item
issuer	false	Reference	# Issuing Organization of Invoice
lineItem	true	Data Type	# Line items of this Invoice
note	true	Annotation	# Comments made about the invoice
participant	true	Data Type	# Participant in creation of this Invoice
paymentTerms	false	markdown	# Payment details
recipient	false	Reference	# Recipient of this invoice
status	false	code	# draft | issued | balanced | cancelled | entered-in-error
subject	false	Reference	# Recipient(s) of goods and services
totalGross	false	Money	# Gross total of this Invoice
totalNet	false	Money	# Net total of this Invoice
totalPriceComponent	true	See Invoice.lineItem.priceComponent	# Components of Invoice total
type	false	CodeableConcept	# Type of Invoice

Invoice Example

{
  "resourceType": "Invoice",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Example of Invoice</div>"
  },
  "identifier": [
    {
      "system": "http://myHospital.org/Invoices",
      "value": "654321"
    }
  ],
  "status": "issued",
  "subject": {
    "reference": "Patient/example"
  },
  "date": "2017-01-25T08:00:00+01:00",
  "participant": [
    {
      "role": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "17561000",
            "display": "Cardiologist"
          }
        ]
      },
      "actor": {
        "reference": "Practitioner/example"
      }
    }
  ],
  "issuer": {
    "identifier": {
      "system": "http://myhospital/NamingSystem/departments",
      "value": "CARD_INTERMEDIATE_CARE"
    }
  },
  "account": {
    "reference": "Account/example"
  },
  "totalNet": {
    "value": 40,
    "currency": "EUR"
  },
  "totalGross": {
    "value": 48,
    "currency": "EUR"
  }
}

Invoice Structure

{
  "resourceType" : "Invoice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for item
  "status" : "<code>", // R!  draft | issued | balanced | cancelled | entered-in-error
  "cancelledReason" : "<string>", // Reason for cancellation of this Invoice
  "type" : { CodeableConcept }, // Type of Invoice
  "subject" : { Reference(Patient|Group) }, // Recipient(s) of goods and services
  "recipient" : { Reference(Organization|Patient|RelatedPerson) }, // Recipient of this invoice
  "date" : "<dateTime>", // Invoice date / posting date
  "participant" : [{ // Participant in creation of this Invoice
    "role" : { CodeableConcept }, // Type of involvement in creation of this Invoice
    "actor" : { Reference(Practitioner|Organization|Patient|PractitionerRole|
    Device|RelatedPerson) } // R!  Individual who was involved
  }],
  "issuer" : { Reference(Organization) }, // Issuing Organization of Invoice
  "account" : { Reference(Account) }, // Account that is being balanced
  "lineItem" : [{ // Line items of this Invoice
    "sequence" : "<positiveInt>", // Sequence number of line item
    // chargeItem[x]: 
      Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2:
    "chargeItemReference" : { Reference(ChargeItem) },
    "chargeItemCodeableConcept" : { CodeableConcept },
    "priceComponent" : [{ // Components of total line item price
      "type" : "<code>", // R!  base | surcharge | deduction | discount | tax | informational
      "code" : { CodeableConcept }, // Code identifying the specific component
      "factor" : <decimal>, // Factor used for calculating this component
      "amount" : { Money } // Monetary amount associated with this component
    }]
  }],
  "totalPriceComponent" : [{ Content as for Invoice.lineItem.priceComponent }], // Components of Invoice total
  "totalNet" : { Money }, // Net total of this Invoice
  "totalGross" : { Money }, // Gross total of this Invoice
  "paymentTerms" : "<markdown>", // Payment details
  "note" : [{ Annotation }] // Comments made about the invoice
}

Invoice Search Parameters

The following search parameters can be used to query Invoice resources. Just submit them like so:

https://api.1up.health/fhir/r4/Invoice?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
account	reference	account
date	date	date
identifier	text	identifier
issuer	reference	issuer
participant	reference	participant.actor
participant-role	text	participant.role
patient	reference	subject.where
recipient	reference	recipient
status	text	status
subject	reference	subject
totalgross	quantity	totalGross
totalnet	quantity	totalNet
type	text	type