invoices

Create Invoice

post
/organizations/{organizationId}/fhir/4/Invoice

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Invoice resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
identifierarray(Identifier)Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
statusdraft|issued|balanced|cancelled|entered-in-errorThe current state of the Invoice.
cancelledReasonstringIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
typeCodeableConceptType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
subjectReferenceThe individual or set of individuals receiving the goods and services billed in this invoice.
recipientReferenceThe individual or Organization responsible for balancing of this invoice.
datedateTimeDate/time(s) of when this Invoice was posted.
participantarray(Invoice_Participant)Indicates who or what performed or participated in the charged service.
issuerReferenceThe organizationissuing the Invoice.
accountReferenceAccount which is supposed to be balanced with this Invoice.
lineItemarray(Invoice_LineItem)Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
totalPriceComponentarray(Invoice_PriceComponent)The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
totalNetMoneyInvoice total , taxes excluded.
totalGrossMoneyInvoice total, tax included.
paymentTermsmarkdownPayment details such as banking details, period of payment, deductibles, methods of payment.
notearray(Annotation)Comments made about the invoice by the issuer, subject, or other participants.

Response

Patch Invoice

patch
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Invoice resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
identifierarray(Identifier)Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
statusdraft|issued|balanced|cancelled|entered-in-errorThe current state of the Invoice.
cancelledReasonstringIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
typeCodeableConceptType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
subjectReferenceThe individual or set of individuals receiving the goods and services billed in this invoice.
recipientReferenceThe individual or Organization responsible for balancing of this invoice.
datedateTimeDate/time(s) of when this Invoice was posted.
participantarray(Invoice_Participant)Indicates who or what performed or participated in the charged service.
issuerReferenceThe organizationissuing the Invoice.
accountReferenceAccount which is supposed to be balanced with this Invoice.
lineItemarray(Invoice_LineItem)Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
totalPriceComponentarray(Invoice_PriceComponent)The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
totalNetMoneyInvoice total , taxes excluded.
totalGrossMoneyInvoice total, tax included.
paymentTermsmarkdownPayment details such as banking details, period of payment, deductibles, methods of payment.
notearray(Annotation)Comments made about the invoice by the issuer, subject, or other participants.

Response

Read Invoice

get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Invoice

get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Invoice

get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Invoice

delete
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Invoice

get
/organizations/{organizationId}/fhir/4/Invoice

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accountstring
datestring
identifierstring
issuerstring
participantstring
participant-rolestring
patientstring
recipientstring
statusstring
subjectstring
totalgrossstring
totalnetstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Invoice

get
/organizations/{organizationId}/fhir/4/Invoice/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Invoice

post
/organizations/{organizationId}/fhir/4/Invoice/_search

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accountstring
datestring
identifierstring
issuerstring
participantstring
participant-rolestring
patientstring
recipientstring
statusstring
subjectstring
totalgrossstring
totalnetstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Invoice resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
identifierarray(Identifier)Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
statusdraft|issued|balanced|cancelled|entered-in-errorThe current state of the Invoice.
cancelledReasonstringIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
typeCodeableConceptType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
subjectReferenceThe individual or set of individuals receiving the goods and services billed in this invoice.
recipientReferenceThe individual or Organization responsible for balancing of this invoice.
datedateTimeDate/time(s) of when this Invoice was posted.
participantarray(Invoice_Participant)Indicates who or what performed or participated in the charged service.
issuerReferenceThe organizationissuing the Invoice.
accountReferenceAccount which is supposed to be balanced with this Invoice.
lineItemarray(Invoice_LineItem)Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
totalPriceComponentarray(Invoice_PriceComponent)The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
totalNetMoneyInvoice total , taxes excluded.
totalGrossMoneyInvoice total, tax included.
paymentTermsmarkdownPayment details such as banking details, period of payment, deductibles, methods of payment.
notearray(Annotation)Comments made about the invoice by the issuer, subject, or other participants.

Response

Update Invoice

put
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Invoice resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
identifierarray(Identifier)Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
statusdraft|issued|balanced|cancelled|entered-in-errorThe current state of the Invoice.
cancelledReasonstringIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
typeCodeableConceptType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
subjectReferenceThe individual or set of individuals receiving the goods and services billed in this invoice.
recipientReferenceThe individual or Organization responsible for balancing of this invoice.
datedateTimeDate/time(s) of when this Invoice was posted.
participantarray(Invoice_Participant)Indicates who or what performed or participated in the charged service.
issuerReferenceThe organizationissuing the Invoice.
accountReferenceAccount which is supposed to be balanced with this Invoice.
lineItemarray(Invoice_LineItem)Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
totalPriceComponentarray(Invoice_PriceComponent)The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
totalNetMoneyInvoice total , taxes excluded.
totalGrossMoneyInvoice total, tax included.
paymentTermsmarkdownPayment details such as banking details, period of payment, deductibles, methods of payment.
notearray(Annotation)Comments made about the invoice by the issuer, subject, or other participants.

Response