Onboarding requirements

To use this service, organisations and system suppliers must meet a set of technical and organisational requirements before getting started.

These requirements ensure that systems can connect to the service safely and that organisations are ready to use it in line with national standards and policy.

The exact requirements will depend on your role, the systems you use and your intended use case.

Organisations need to:

• have an appropriate use case for the service
• ensure the service will be used in line with national policy and for approved purposes
• have the necessary governance, approvals and operational readiness in place

This may include confirming how the service will be used within workflows and ensuring relevant teams are prepared to support its use.

Systems need to:

• be capable of integrating with the service
• be able to send, receive or process the required data
• meet national standards and interface requirements

System suppliers are responsible for ensuring their products meet these requirements before using the service.

Access to the service is controlled and subject to approval.

Organisations and suppliers must:

• meet eligibility criteria for using the service
• be approved for specific use cases
• use systems that have been assured for use with the service

Approval processes and requirements may vary depending on the service and how it is used.

In most cases, using this service depends on other services or components.

These may be required to:

• identify patients, organisations or systems
• locate the correct system to connect to
• support messaging or data exchange

The specific dependencies will vary depending on your use case and system architecture.

Once the required conditions are in place, onboarding typically involves completing a series of steps to gain access to and start using the service.

For example, you might need to:

• provide organisation and system details to request access
• complete access or data sharing forms
• meet data security and assurance requirements
• request access to relevant services or datasets
• set up access and authentication for users

The exact steps and order will depend on your role, systems and use case.

Once these requirements are in place, you can begin onboarding for this service.

You can find guidance on the steps involved in implementation and integration.

Get your questions answered on the Developer Community.

• How this service works
• When to use this service
• Compliance and governance requirements
• Implementation and integration