Skip to main content

P3 Consent and notifications

P3 is the other side of M3 Retrieve. M3 is a requester asking for records. P3 is the patient deciding, and being told each time.

A citizen fetching records is the HIU, so every PHR application must implement that side.

Try the P3 APIs
Every call in P3, one page each: the headers it needs, the payload it takes, the callback it triggers, and a request builder you can fire at the sandbox.
Error codes
What each code P3 returns actually means, and the first thing to check when you see one.

In short​

  • Build for revocation from the start. A consent that worked yesterday can be withdrawn today, and that is the system working correctly.
  • A subscription is how your app hears about changes to a user's ABHA address. Set one up at address creation and at first login on a new install.
  • An auto approval policy stops the user approving a request every time a hospital adds a record.
  • The user must be able to disable a policy at any time.

Subscriptions and notifications​

Ask the user for consent before you create a subscription. An approved subscription notifies your app of a new care context, a modified care context, a new consent request and a new subscription request. Surface these as device notifications.

You need screens to list subscriptions, approve them, deny them and edit them. Editing covers health information types, types of visit and the time period.

Auto approval: subscribe once, approve every time​

  1. Ask the user to confirm your app may retrieve new linked records automatically.
  2. Set up an auto approval policy with the HIE-CM.
  3. Save the auto approval ID the HIE-CM returns.

While the policy is active, the consent request you raise on a new or updated care context notification is granted immediately, and you fetch and store the record. Disable the policy and a request arrives for each record instead.

CapabilityWhat it covers
View requestsRequesting HIU, purpose, data types, date range, validity, status
Modify a requestAccess duration, record date range, data categories, validity period
Grant or denyThe decision goes back to the HIE-CM
View active consentsWho currently has access, and to what
RevokeWithdraw at any time. Sharing under that consent stops immediately

The Consents tab and the Subscriptions tab group state the same way: a Requests section holding Requested, Denied and Expired, and an Approved section holding Granted and Revoked.

Fetching and displaying records​

Once a care context is linked to the user's ABHA address:

  1. Your app receives the notification.
  2. It creates a consent request for that record and sends it to the HIE-CM.
  3. The consent is granted, automatically if a policy exists, otherwise by the user.
  4. It raises a health information request with the approved consent artefact.
  5. The HIP sends the records across the network.
  6. Your app stores them for long term access and displays them, preferably in chronological order.

The test cases cover every health information type, structured and unstructured: diagnostic report, prescription, discharge summary, consultation note, immunisation record, wellness record and health document record.

Next​

Last updated on