Organisations

Platform APIs do not support browser Javascript initiated calls that required specific CORS (Cross-origin resource sharing) domains to be allow listed, we recommend a BFF pattern in place of direct client interaction with platform APIs

Organisations allow users who acts as agents within an application to collectively gain consent over an individuals data. With one or more organisation in place an agency request can be made on behalf of the organisation as a whole, meaning the individual will accept consent for any member of the organisation to access their health data.

Currently organisations must be created by our support team, please reach out to us to discuss your how you wish to integrate organisations within your service.

A membership manager can access their organisations via the main navigation menu:

List organisations

When created one or more users can be assigned as Membership Managers, a membership manager is provided the ability to invite others to the organisation as agents.

A “membership manager” is NOT an agent, they are different roles and a membership manager does not have the ability to query health data without also being assigned as an agent.

View your organisation members

Within your organisation you can see a list of all members within the organisation:

View organisation

Inviting and Joining an organisation

A membership manager will have the ability to invite an individual to an organisation. Specify the email address of the individual and select a role from Membership Manager or Agent

Invite to organisation

Once invited the membership manager can review a list of outstanding invitations and issue a re-send or withdraw of the invite.

organisation members

Organisations API

The organisations API does not allow programmatic management of organisations, however it is possible to retrieve a list of organisations an authenticated user is a member of, see the OpenAPI API specification document here for details.