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* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Invoice resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |
status | draft|issued|balanced|cancelled|entered-in-error | The current state of the Invoice. | |
cancelledReason | string | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). | |
type | CodeableConcept | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). | |
subject | Reference | The individual or set of individuals receiving the goods and services billed in this invoice. | |
recipient | Reference | The individual or Organization responsible for balancing of this invoice. | |
date | dateTime | Date/time(s) of when this Invoice was posted. | |
participant | array(Invoice_Participant) | Indicates who or what performed or participated in the charged service. | |
issuer | Reference | The organizationissuing the Invoice. | |
account | Reference | Account which is supposed to be balanced with this Invoice. | |
lineItem | array(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. | |
totalPriceComponent | array(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. | |
totalNet | Money | Invoice total , taxes excluded. | |
totalGross | Money | Invoice total, tax included. | |
paymentTerms | markdown | Payment details such as banking details, period of payment, deductibles, methods of payment. | |
note | array(Annotation) | Comments made about the invoice by the issuer, subject, or other participants. |
Response
keyboard_arrow_down
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* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Invoice resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |
status | draft|issued|balanced|cancelled|entered-in-error | The current state of the Invoice. | |
cancelledReason | string | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). | |
type | CodeableConcept | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). | |
subject | Reference | The individual or set of individuals receiving the goods and services billed in this invoice. | |
recipient | Reference | The individual or Organization responsible for balancing of this invoice. | |
date | dateTime | Date/time(s) of when this Invoice was posted. | |
participant | array(Invoice_Participant) | Indicates who or what performed or participated in the charged service. | |
issuer | Reference | The organizationissuing the Invoice. | |
account | Reference | Account which is supposed to be balanced with this Invoice. | |
lineItem | array(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. | |
totalPriceComponent | array(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. | |
totalNet | Money | Invoice total , taxes excluded. | |
totalGross | Money | Invoice total, tax included. | |
paymentTerms | markdown | Payment details such as banking details, period of payment, deductibles, methods of payment. | |
note | array(Annotation) | Comments made about the invoice by the issuer, subject, or other participants. |
Response
keyboard_arrow_down
Read Invoice
get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Invoice
get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Invoice
get
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Invoice
delete
/organizations/{organizationId}/fhir/4/Invoice/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Invoice
get
/organizations/{organizationId}/fhir/4/Invoice
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
account | string | ||
date | |||
identifier | string | ||
issuer | string | ||
participant | string | ||
participant-role | string | ||
patient | string | ||
recipient | string | ||
status | string | ||
subject | string | ||
totalgross | string | ||
totalnet | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Invoice
get
/organizations/{organizationId}/fhir/4/Invoice/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
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* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
account | string | ||
date | |||
identifier | string | ||
issuer | string | ||
participant | string | ||
participant-role | string | ||
patient | string | ||
recipient | string | ||
status | string | ||
subject | string | ||
totalgross | string | ||
totalnet | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Invoice resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |
status | draft|issued|balanced|cancelled|entered-in-error | The current state of the Invoice. | |
cancelledReason | string | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). | |
type | CodeableConcept | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). | |
subject | Reference | The individual or set of individuals receiving the goods and services billed in this invoice. | |
recipient | Reference | The individual or Organization responsible for balancing of this invoice. | |
date | dateTime | Date/time(s) of when this Invoice was posted. | |
participant | array(Invoice_Participant) | Indicates who or what performed or participated in the charged service. | |
issuer | Reference | The organizationissuing the Invoice. | |
account | Reference | Account which is supposed to be balanced with this Invoice. | |
lineItem | array(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. | |
totalPriceComponent | array(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. | |
totalNet | Money | Invoice total , taxes excluded. | |
totalGross | Money | Invoice total, tax included. | |
paymentTerms | markdown | Payment details such as banking details, period of payment, deductibles, methods of payment. | |
note | array(Annotation) | Comments made about the invoice by the issuer, subject, or other participants. |
Response
keyboard_arrow_down
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* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Invoice resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |
status | draft|issued|balanced|cancelled|entered-in-error | The current state of the Invoice. | |
cancelledReason | string | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). | |
type | CodeableConcept | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). | |
subject | Reference | The individual or set of individuals receiving the goods and services billed in this invoice. | |
recipient | Reference | The individual or Organization responsible for balancing of this invoice. | |
date | dateTime | Date/time(s) of when this Invoice was posted. | |
participant | array(Invoice_Participant) | Indicates who or what performed or participated in the charged service. | |
issuer | Reference | The organizationissuing the Invoice. | |
account | Reference | Account which is supposed to be balanced with this Invoice. | |
lineItem | array(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. | |
totalPriceComponent | array(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. | |
totalNet | Money | Invoice total , taxes excluded. | |
totalGross | Money | Invoice total, tax included. | |
paymentTerms | markdown | Payment details such as banking details, period of payment, deductibles, methods of payment. | |
note | array(Annotation) | Comments made about the invoice by the issuer, subject, or other participants. |
Response
keyboard_arrow_down