Invoice - FHIR Resource (r4)
This Invoice Resource uses the FHIR API standard for access and structure.
Validate an Invoice FHIR Resource (r4)
Invoice Attributes
AttributeField is listTypeDescription
Description: Business Identifier for item
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://myHospital.org/Invoices",
"value": "654321"
}
]Learn more about the (Invoice) identifier FHIR attribute
Description: draft | issued | balanced | cancelled | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "issued"Learn more about the (Invoice) status FHIR attribute
Description: Reason for cancellation of this Invoice
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"cancelledReason": Learn more about the (Invoice) cancelledReason FHIR attribute
Description: Type of Invoice
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Invoice) type FHIR attribute
Description: Recipient(s) of goods and services
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (Invoice) subject FHIR attribute
Description: Recipient of this invoice
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": Learn more about the (Invoice) recipient FHIR attribute
Description: Invoice date / posting date
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2017-01-25T08:00:00+01:00"Learn more about the (Invoice) date FHIR attribute
Description: Participant in creation of this Invoice
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": [
{
"role": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "17561000",
"display": "Cardiologist"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
]Learn more about the (Invoice) participant FHIR attribute
Description: Issuing Organization of Invoice
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"issuer": {
"identifier": {
"system": "http://myhospital/NamingSystem/departments",
"value": "CARD_INTERMEDIATE_CARE"
}
}Learn more about the (Invoice) issuer FHIR attribute
Description: Account that is being balanced
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"account": {
"reference": "Account/example"
}Learn more about the (Invoice) account FHIR attribute
Description: Line items of this Invoice
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lineItem": Learn more about the (Invoice) lineItem FHIR attribute
Description: Components of Invoice total
FHIR Version: r4
Attribute Type : See Invoice.lineItem.priceComponent
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"totalPriceComponent": Learn more about the (Invoice) totalPriceComponent FHIR attribute
Description: Net total of this Invoice
FHIR Version: r4
Attribute Type : Money
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"totalNet": {
"value": 40,
"currency": "EUR"
}Learn more about the (Invoice) totalNet FHIR attribute
Description: Gross total of this Invoice
FHIR Version: r4
Attribute Type : Money
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"totalGross": {
"value": 48,
"currency": "EUR"
}Learn more about the (Invoice) totalGross FHIR attribute
Description: Payment details
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"paymentTerms": Learn more about the (Invoice) paymentTerms FHIR attribute
Description: Comments made about the invoice
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Invoice) note FHIR attribute
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 |
