ovok_sdk.resources.patient_billing
The `ovok.patient_billing` namespace: patients' insurance, plans, billing accounts and invoices.
- Stable unknown
- Release candidate not available
- Development since 0.2.0-dev.34+53a6a64
The ovok.patient_billing namespace: patients' insurance, plans, billing accounts and invoices.
PatientBillingInsurersResource
PatientBillingInsurersResource(billing: HttpClient)Insurers a coverage may name; access it as ovok.patient_billing.insurers.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
billing | HttpClient | The HTTP client scoped to the patient billing routes. |
list()
list(
params: JsonObject | None = None,
*,
options: RequestOptions | None = None,
) -> list[Any]Find insurers.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
params | JsonObject | None | None | Optional country (DE), kind (statutory or private) and query text. |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
list[Any]: The insurers.
PatientBillingCoveragesResource
PatientBillingCoveragesResource(billing: HttpClient)Patients' health insurance; access it as ovok.patient_billing.coverages.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
billing | HttpClient | The HTTP client scoped to the patient billing routes. |
list()
list(patient_id: str, *, options: RequestOptions | None = None) -> list[Any]List a patient's coverages.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
list[Any]: The coverages, in theirorder.
create()
create(
patient_id: str,
body: JsonObject,
*,
options: RequestOptions | None = None,
) -> AnyAdd a coverage to a patient.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
body | JsonObject | The coverage: its kind (statutory, private or self-pay) and the insurer and member number that kind needs. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The coverage.
update()
update(
coverage_id: str,
changes: JsonObject,
*,
if_version: str | None = None,
options: RequestOptions | None = None,
) -> AnyChange a coverage.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
coverage_id | str | The coverage ID. | |
changes | JsonObject | The fields to change. | |
if_version | str | None | None | The version you read; a coverage changed since is refused with OvokConflictError. |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The coverage after the change.
remove()
remove(coverage_id: str, *, options: RequestOptions | None = None) -> NoneRemove a coverage.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
coverage_id | str | The coverage ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
PatientBillingPlansResource
PatientBillingPlansResource(billing: HttpClient)The plan each patient pays for; access it as ovok.patient_billing.plans.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
billing | HttpClient | The HTTP client scoped to the patient billing routes. |
retrieve()
retrieve(patient_id: str, *, options: RequestOptions | None = None) -> AnyRead a patient's plan.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The plan.
set()
set(
patient_id: str,
body: JsonObject,
*,
options: RequestOptions | None = None,
) -> Any | NoneSet or end a patient's plan.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
body | JsonObject | plan (a coding, or None to end it) and an optional period. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any | None: The plan, or None whenplanwas None.
PatientBillingAccountsResource
PatientBillingAccountsResource(billing: HttpClient)Patients' billing accounts; access it as ovok.patient_billing.accounts.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
billing | HttpClient | The HTTP client scoped to the patient billing routes. |
list()
list(patient_id: str, *, options: RequestOptions | None = None) -> list[Any]List a patient's billing accounts.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
list[Any]: The accounts.
retrieve()
retrieve(account_id: str, *, options: RequestOptions | None = None) -> AnyRead one billing account.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
account_id | str | The account ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The account.
PatientBillingInvoicesResource
PatientBillingInvoicesResource(billing: HttpClient)Patients' invoices; access it as ovok.patient_billing.invoices.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
billing | HttpClient | The HTTP client scoped to the patient billing routes. |
list()
list(
patient_id: str,
params: JsonObject | None = None,
*,
options: RequestOptions | None = None,
) -> Page[Any]List a patient's invoices.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
params | JsonObject | None | None | Optional limit per page. |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Page[Any]: A page of invoices that loads later pages on demand.
retrieve()
retrieve(invoice_id: str, *, options: RequestOptions | None = None) -> AnyRead one invoice.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
invoice_id | str | The invoice ID. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The invoice.
record()
record(
patient_id: str,
body: JsonObject,
*,
options: RequestOptions | None = None,
) -> AnyRecord an invoice issued elsewhere; the same identifier again answers the same invoice.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
patient_id | str | The Patient's ID. | |
body | JsonObject | identifier, status, issuedAt, lines and optional total and cancelledReason. | |
options | RequestOptions | None | None | Per-request options; timeout overrides the client's. |
Returns
Any: The invoice.
PatientBillingResource
PatientBillingResource(http: HttpClient)Patients' health insurance, plans, billing accounts and invoices.
Created by Ovok; access it as ovok.patient_billing.
Last updated on