accounts
Create Account
post
/organizations/{organizationId}/fhir/3/Account
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | Account | This is a Account resource |
identifier | array(Identifier) | Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number). | |
status | string | active|inactive|entered-in-error | Indicates whether the account is presently used/usable or not. |
type | CodeableConcept | Categorizes the account for reporting and searching purposes. | |
name | string | Name used for the account when displaying it to humans in reports, etc. | |
subject | Reference | Identifies the patient, device, practitioner, location or other object the account is associated with. | |
period | Period | Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. | |
active | Period | Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. | |
balance | Money | Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. | |
coverage | array(Account_Coverage) | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. | |
owner | Reference | Indicates the organization, department, etc. with responsibility for the account. | |
description | string | Provides additional information about what the account tracks and how it is used. | |
guarantor | array(Account_Guarantor) | Parties financially responsible for the account. |
Response
keyboard_arrow_down
Patch Account
patch
/organizations/{organizationId}/fhir/3/Account/{resourceId}
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
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* | string | Account | This is a Account resource |
identifier | array(Identifier) | Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number). | |
status | string | active|inactive|entered-in-error | Indicates whether the account is presently used/usable or not. |
type | CodeableConcept | Categorizes the account for reporting and searching purposes. | |
name | string | Name used for the account when displaying it to humans in reports, etc. | |
subject | Reference | Identifies the patient, device, practitioner, location or other object the account is associated with. | |
period | Period | Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. | |
active | Period | Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. | |
balance | Money | Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. | |
coverage | array(Account_Coverage) | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. | |
owner | Reference | Indicates the organization, department, etc. with responsibility for the account. | |
description | string | Provides additional information about what the account tracks and how it is used. | |
guarantor | array(Account_Guarantor) | Parties financially responsible for the account. |
Response
keyboard_arrow_down
Read Account
get
/organizations/{organizationId}/fhir/3/Account/{resourceId}
Request
Headers
content-type* | string | application/json | 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 Account
get
/organizations/{organizationId}/fhir/3/Account/{resourceId}/_history
Request
Headers
content-type* | string | application/json | 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 Account
get
/organizations/{organizationId}/fhir/3/Account/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json | 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 Account
delete
/organizations/{organizationId}/fhir/3/Account/{resourceId}
Request
Headers
content-type* | string | application/json | 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 Account
get
/organizations/{organizationId}/fhir/3/Account
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
balance | string | ||
identifier | string | ||
name | string | ||
owner | string | ||
patient | string | ||
period | string | ||
status | string | ||
subject | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Account
get
/organizations/{organizationId}/fhir/3/Account/_history
Request
Headers
content-type* | string | application/json | 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 Account
post
/organizations/{organizationId}/fhir/3/Account/_search
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
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 | ||
balance | string | ||
identifier | string | ||
name | string | ||
owner | string | ||
patient | string | ||
period | string | ||
status | string | ||
subject | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | Account | This is a Account resource |
identifier | array(Identifier) | Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number). | |
status | string | active|inactive|entered-in-error | Indicates whether the account is presently used/usable or not. |
type | CodeableConcept | Categorizes the account for reporting and searching purposes. | |
name | string | Name used for the account when displaying it to humans in reports, etc. | |
subject | Reference | Identifies the patient, device, practitioner, location or other object the account is associated with. | |
period | Period | Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. | |
active | Period | Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. | |
balance | Money | Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. | |
coverage | array(Account_Coverage) | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. | |
owner | Reference | Indicates the organization, department, etc. with responsibility for the account. | |
description | string | Provides additional information about what the account tracks and how it is used. | |
guarantor | array(Account_Guarantor) | Parties financially responsible for the account. |
Response
keyboard_arrow_down
Update Account
put
/organizations/{organizationId}/fhir/3/Account/{resourceId}
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
Request
Headers
content-type* | string | application/json | 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* | string | Account | This is a Account resource |
identifier | array(Identifier) | Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number). | |
status | string | active|inactive|entered-in-error | Indicates whether the account is presently used/usable or not. |
type | CodeableConcept | Categorizes the account for reporting and searching purposes. | |
name | string | Name used for the account when displaying it to humans in reports, etc. | |
subject | Reference | Identifies the patient, device, practitioner, location or other object the account is associated with. | |
period | Period | Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. | |
active | Period | Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. | |
balance | Money | Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. | |
coverage | array(Account_Coverage) | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. | |
owner | Reference | Indicates the organization, department, etc. with responsibility for the account. | |
description | string | Provides additional information about what the account tracks and how it is used. | |
guarantor | array(Account_Guarantor) | Parties financially responsible for the account. |
Response
keyboard_arrow_down