v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB

InvoiceLine

List Invoice Lines

Retrieves a list or collection of invoice lines (i.e. a fee added to an invoice)

get/main/InvoiceLine

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

The logical id of the resource

createdstring datetime

When the resource was created.

subjectstring

Patient who is the subject of the invoice line

performerstring

Reference to the performer for the invoice line.

invoicestring

Reference to the invoice it belong.

funderstring

Reference to the funder it belong.

referralstring

Reference to the referral it belong.

coveragestring

Reference to the claim it belong.

_lastUpdatedstring datetime

Date the invoice line was last updated.

amountstring

The amount of the invoice line

_include'InvoiceLine:subject' | 'InvoiceLine:performer' | 'InvoiceLine:invoice'

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

_include:iterate = can be used to include related resources based on already included resources.

Response

InvoiceLine collection

descriptionstring nullable

The fee or package name

definitionCanonicalstring[]

The reference URL of the fee (ChargeItemDefinition) charged on this invoice line

status'voided' | 'unassigned' | 'write-off' | 'locked' | 'null' nullable

Status of the invoice line

codestring nullable

Fee item number

occurrenceDateTimestring date-time nullable

Date of the occurrence

enteredDatestring date-time nullable

Created date of the invoice line

quantitynumber nullable

Quantity of the fee on the invoice line

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type