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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv

Params

organizationId*string|stringid|slug

Body

resourceType*stringAccountThis is a Account resource
identifierarray(Identifier)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
statusstringactive|inactive|entered-in-errorIndicates whether the account is presently used/usable or not.
typeCodeableConceptCategorizes the account for reporting and searching purposes.
namestringName used for the account when displaying it to humans in reports, etc.
subjectReferenceIdentifies the patient, device, practitioner, location or other object the account is associated with.
periodPeriodIdentifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
activePeriodIndicates 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.
balanceMoneyRepresents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
coveragearray(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.
ownerReferenceIndicates the organization, department, etc. with responsibility for the account.
descriptionstringProvides additional information about what the account tracks and how it is used.
guarantorarray(Account_Guarantor)Parties financially responsible for the account.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAccountThis is a Account resource
identifierarray(Identifier)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
statusstringactive|inactive|entered-in-errorIndicates whether the account is presently used/usable or not.
typeCodeableConceptCategorizes the account for reporting and searching purposes.
namestringName used for the account when displaying it to humans in reports, etc.
subjectReferenceIdentifies the patient, device, practitioner, location or other object the account is associated with.
periodPeriodIdentifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
activePeriodIndicates 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.
balanceMoneyRepresents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
coveragearray(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.
ownerReferenceIndicates the organization, department, etc. with responsibility for the account.
descriptionstringProvides additional information about what the account tracks and how it is used.
guarantorarray(Account_Guarantor)Parties financially responsible for the account.

Response

Read Account

get
/organizations/{organizationId}/fhir/3/Account/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Account

get
/organizations/{organizationId}/fhir/3/Account/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Account

get
/organizations/{organizationId}/fhir/3/Account/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Account

delete
/organizations/{organizationId}/fhir/3/Account/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Account

get
/organizations/{organizationId}/fhir/3/Account

Request

Headers

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

Query params

_idstring
_languagestring
balancestring
identifierstring
namestring
ownerstring
patientstring
periodstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Account

get
/organizations/{organizationId}/fhir/3/Account/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
balancestring
identifierstring
namestring
ownerstring
patientstring
periodstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAccountThis is a Account resource
identifierarray(Identifier)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
statusstringactive|inactive|entered-in-errorIndicates whether the account is presently used/usable or not.
typeCodeableConceptCategorizes the account for reporting and searching purposes.
namestringName used for the account when displaying it to humans in reports, etc.
subjectReferenceIdentifies the patient, device, practitioner, location or other object the account is associated with.
periodPeriodIdentifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
activePeriodIndicates 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.
balanceMoneyRepresents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
coveragearray(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.
ownerReferenceIndicates the organization, department, etc. with responsibility for the account.
descriptionstringProvides additional information about what the account tracks and how it is used.
guarantorarray(Account_Guarantor)Parties financially responsible for the account.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAccountThis is a Account resource
identifierarray(Identifier)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
statusstringactive|inactive|entered-in-errorIndicates whether the account is presently used/usable or not.
typeCodeableConceptCategorizes the account for reporting and searching purposes.
namestringName used for the account when displaying it to humans in reports, etc.
subjectReferenceIdentifies the patient, device, practitioner, location or other object the account is associated with.
periodPeriodIdentifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
activePeriodIndicates 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.
balanceMoneyRepresents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
coveragearray(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.
ownerReferenceIndicates the organization, department, etc. with responsibility for the account.
descriptionstringProvides additional information about what the account tracks and how it is used.
guarantorarray(Account_Guarantor)Parties financially responsible for the account.

Response