ovok.sharing

ovok.sharing lets a patient share chosen observation codes with another person, and see or revoke those shares. Patient apps call it for the signed-in patient. A project admin turns sharing on in the sharing settings.

Invite someoneCopy Anchor Link

The patient creates an invite for a set of observation codes and passes the inviteId and code to the recipient.

const invite = await ovok.sharing.invites.create({
  codes: ['8867-4'],
  endsAt: null,
});

console.log(invite.inviteId, invite.code, invite.expiresAt);

• endsAt is an ISO 8601 end time, or null for no end.
• The invite expires at expiresAt.

Redeem an inviteCopy Anchor Link

The recipient redeems it while signed in.

const share = await ovok.sharing.invites.redeem({ inviteId, code });

• It resolves to the created share.
• To accept a record-share invite with the active profile, ovok.invites.accept picks the right route for you.

List and revoke sharesCopy Anchor Link

const { outgoing, incoming, practitioners, relatedPersons, received } = await ovok.sharing.shares.list();

await ovok.sharing.shares.revoke(consentId);

• Groups the server does not send yet come back as empty arrays.
• revoke takes the id of the share's consent.

Change sharing settingsCopy Anchor Link

const settings = await ovok.sharing.settings.retrieve();

await ovok.sharing.settings.update({ enabled: true, practitionerSharingEnabled: true });

• update replaces the settings. practitionerSharingEnabled: null leaves that flag unchanged.

ReferenceCopy Anchor Link

• sharing API reference: every method and type.
• invites guide
• Errors and retries