HL7 Integration Process

To help our customers plan for and understand what is involved in a "standard" HL7 integration project, we have created a generic list of steps that our Trust deployments follow. These are facilitated in more depth via a project plan within our project management system (TeamWork) which our Success team build and support. Each site has varying specifications so some additional tasks can be needed.


  1. Project Initiation Document completed and agreed, with the integration requirements clearly scoped and defined.

  2. IG requirements completed. See our online documentation for further details. Project Manager

  3. Project Kickoff: Project Manager takes over the PID

  4. Send out HL7 documentation for review (if not done previously): HL7 specifications, connectivity information and additional supporting information are all available in the PKB developer wiki. Project Manager

  5. Sandbox test site created: Sandbox test-site created, test accounts created and log-in details sent out (patient, professional, coordinator, org admin for the org patient records (umbrella) team) and at least one speciality team. Project Manager

  6. Kickoff Integration call with integration specialist: PKB generated Integration specification shared and reviewed, HL7 message specifications and work-streams confirmed, possible risks identified. Client integrations team, Project Manager + Integration Specialist

  7. HL7 credentials for Sandbox are shared with the customer. Integration Specialist

  8. Super admin settings updated for client organisation on Sandbox. Integration Specialist

  9. Connectivity established: Ensure client has whitelisted https://sandbox.patientsknowbest.com:7443/services/hl7. Client + Project Manager

  10. Integration development undertaken. Client

  11. UAT Testing (including all code sets and patient matching issues). Whilst the client is ultimately responsible for their own internal testing processes and governance, PKB provides some example Test Scripts for consideration. The PKB integration specialist will also undertake due diligence in reviewing and supporting the testing, assuring that expectations in relation to data quality and workflow are met before enabling any move to production. Client + Project Manager + Integration Specialist

  12. Multi-source testing done with PKB messages. Client + Project Manager + Integration Specialist

  13. UAT testing on Sandbox completed and signed off using the Integration specification as a "source of truth". Client + Project Manager + Integration Specialist

  14. Production site created: Client supplies details according to PKB request. Production site created and coordinator will be invited to register. Project Manager + Client

  15. Super admin settings updated and code sets setup for production using client-supplied details. Integration Specialist

  16. Client firewall opened for PKB production environment (connectivity information and testing guidance). Client

  17. Prod HL7 credentials created by PKB and whitelist customer IP address(es). Project Manager + Integration Specialist

  18. Prod HL7 credentials sent to client. Integration Specialist

  19. Production connectivity established and confirmed. Client + Project Manager

  20. Schedule a Go-Live time where all will be available. Client + Project Manager

  21. Interfaces switched on for 1-hour testing load and last QA verification (to be done by a clinician with patient consent - implicit or explicit). Client + Project Manager

  22. Go-Live.