API referenceovok_sdk.resources

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

NameTypeDefaultDescription
billingHttpClientThe HTTP client scoped to the patient billing routes.

list()

list(
    params: JsonObject | None = None,
    *,
    options: RequestOptions | None = None,
) -> list[Any]

Find insurers.

Parameters

NameTypeDefaultDescription
paramsJsonObject | NoneNoneOptional country (DE), kind (statutory or private) and query text.
optionsRequestOptions | NoneNonePer-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

NameTypeDefaultDescription
billingHttpClientThe 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

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • list[Any]: The coverages, in their order.

create()

create(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any

Add a coverage to a patient.

Parameters

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
bodyJsonObjectThe coverage: its kind (statutory, private or self-pay) and the insurer and member number that kind needs.
optionsRequestOptions | NoneNonePer-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,
) -> Any

Change a coverage.

Parameters

NameTypeDefaultDescription
coverage_idstrThe coverage ID.
changesJsonObjectThe fields to change.
if_versionstr | NoneNoneThe version you read; a coverage changed since is refused with OvokConflictError.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • Any: The coverage after the change.

remove()

remove(coverage_id: str, *, options: RequestOptions | None = None) -> None

Remove a coverage.

Parameters

NameTypeDefaultDescription
coverage_idstrThe coverage ID.
optionsRequestOptions | NoneNonePer-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

NameTypeDefaultDescription
billingHttpClientThe HTTP client scoped to the patient billing routes.

retrieve()

retrieve(patient_id: str, *, options: RequestOptions | None = None) -> Any

Read a patient's plan.

Parameters

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • Any: The plan.

set()

set(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any | None

Set or end a patient's plan.

Parameters

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
bodyJsonObjectplan (a coding, or None to end it) and an optional period.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • Any | None: The plan, or None when plan was None.

PatientBillingAccountsResource

PatientBillingAccountsResource(billing: HttpClient)

Patients' billing accounts; access it as ovok.patient_billing.accounts.

Parameters

NameTypeDefaultDescription
billingHttpClientThe 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

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • list[Any]: The accounts.

retrieve()

retrieve(account_id: str, *, options: RequestOptions | None = None) -> Any

Read one billing account.

Parameters

NameTypeDefaultDescription
account_idstrThe account ID.
optionsRequestOptions | NoneNonePer-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

NameTypeDefaultDescription
billingHttpClientThe 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

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
paramsJsonObject | NoneNoneOptional limit per page.
optionsRequestOptions | NoneNonePer-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) -> Any

Read one invoice.

Parameters

NameTypeDefaultDescription
invoice_idstrThe invoice ID.
optionsRequestOptions | NoneNonePer-request options; timeout overrides the client's.

Returns

  • Any: The invoice.

record()

record(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any

Record an invoice issued elsewhere; the same identifier again answers the same invoice.

Parameters

NameTypeDefaultDescription
patient_idstrThe Patient's ID.
bodyJsonObjectidentifier, status, issuedAt, lines and optional total and cancelledReason.
optionsRequestOptions | NoneNonePer-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

On this page