Invoice - FHIR Resource (r4)


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

Validate an Invoice FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
accountfalseReference# Account that is being balanced
cancelledReasonfalsestring# Reason for cancellation of this Invoice
datefalsedateTime# Invoice date / posting date
identifiertrueIdentifier# Business Identifier for item
issuerfalseReference# Issuing Organization of Invoice
lineItemtrueData Type# Line items of this Invoice
notetrueAnnotation# Comments made about the invoice
participanttrueData Type# Participant in creation of this Invoice
paymentTermsfalsemarkdown# Payment details
recipientfalseReference# Recipient of this invoice
statusfalsecode# draft | issued | balanced | cancelled | entered-in-error
subjectfalseReference# Recipient(s) of goods and services
totalGrossfalseMoney# Gross total of this Invoice
totalNetfalseMoney# Net total of this Invoice
totalPriceComponenttrueSee Invoice.lineItem.priceComponent# Components of Invoice total
typefalseCodeableConcept# 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 ParameterField TypeResource Fields Searched
accountreferenceaccount
datedatedate
identifiertextidentifier
issuerreferenceissuer
participantreferenceparticipant.actor
participant-roletextparticipant.role
patientreferencesubject.where
recipientreferencerecipient
statustextstatus
subjectreferencesubject
totalgrossquantitytotalGross
totalnetquantitytotalNet
typetexttype