ovok_sdk.resources.sharing

The ovok.sharing namespace: patient record sharing.

SharingInvitesResourceCopy Anchor Link

SharingInvitesResource(http: HttpClient)

Share invitations a patient creates and a recipient redeems.

Access it as ovok.sharing.invites.

create()Copy Anchor Link

create(body: JsonObject) -> Any

Create a share invitation.

Parameters

Returns

• Any: The created invitation.

redeem()Copy Anchor Link

redeem(body: JsonObject) -> Any

Redeem a share invitation.

Parameters

Returns

• Any: The API's response.

SharingSettingsResourceCopy Anchor Link

SharingSettingsResource(http: HttpClient)

The patient's sharing settings.

Access it as ovok.sharing.settings.

retrieve()Copy Anchor Link

retrieve() -> Any

Read the sharing settings.

Returns

• Any: The settings as the API returns them.

update()Copy Anchor Link

update(settings: JsonObject) -> Any

Replace the sharing settings.

Parameters

Returns

• Any: The updated settings.

SharingSharesResourceCopy Anchor Link

SharingSharesResource(http: HttpClient)

Active shares of the patient's record.

Access it as ovok.sharing.shares.

list()Copy Anchor Link

list() -> Any

List the active shares.

Returns

• Any: The shares grouped by kind; practitioners, relatedPersons and received
• Any: are always present, empty when there are none.

revoke()Copy Anchor Link

revoke(consent_id: str) -> None

Revoke a share.

Parameters

SharingResourceCopy Anchor Link

SharingResource(http: HttpClient)

Patient record sharing: invitations, shares and settings.

Created by Ovok; access it as ovok.sharing.