Setting up an HL7 API configuration

Fill out the form

If you would like to request credentials, please contact your PKB success lead.

Notes on completing the form

Before you start

It is assumed that you have already received an overview of PKB, and where relevant, the various roles have been agreed and decisions regarding which Organisations and Teams are to be created have already been taken.


This form is intended to capture the information required by PKB to create and configure an HL7 interface connection for you. Some of the options relate to the content of the HL7 messages, whilst some relate to other configuration options that can be set for the interface. Summary explanations are given for the individual options; please see the HL7 API documentation for a more comprehensive explanation of the relevant features. Links to further information are provided within the form itself.

Once the form has been submitted, PKB will create and configure a new HL7 interface and issue you with the relevant credentials.


© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.

This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.