REST API integration steps

See also: IT Department Documentation about Patients Know Best and HL7 API integration steps

We have created a generic task list to use with our deployments for REST API integrations to give you an insight into what is usually involved (see image below). Each site has varying specifications so some additional tasks can be needed. We have based the due dates on the premise that the customer has a technical lead available for one day a week to work on integration.

Details

  1. Send out REST documentation: PKB publishes a specification of REST API operations in our online documentation. Integrating partner should read through the specifications https://sandbox.patientsknowbest.com/api/index.html and http://dev.patientsknowbest.com/home/rest-api and decide which (if any) 2-way REST integrations to implement.
  2. Welcome call with integration team This call will give the customer an opportunity to raise any issues not yet addressed by the documentation and for the architecture of the integration to be discussed. During this a decision is made if the partner will use a system client ID or a user client ID and the configuration forms to request credentials for sandbox testing are stepped through. http://dev.patientsknowbest.com/home/rest-api/obtaining-a-rest-api-client-id
  3. Information Governance sign-offOnce all IG issues have been discussed to the satisfaction of all parties, IG sign-off can occur. Assurance Criteria is defined here.
  4. Customer applies for REST API accessAccess to the PKB REST API requires PKB to configure a Client ID for the customer. Information about this process can be found in our online documentation
  5. Agree REST message specification: PKB publishes a specification for the REST messages we support in our online documentation. https://sandbox.patientsknowbest.com/api/index.html The integrating partner should fully review and determine which they intend to use.
  6. PKB configures REST API Client IDPKB reviews the information provided in step 4, and configures an appropriate Client ID. This is provided to the customer. 
  7. PKB configures test site credentialsIf required, PKB configures a test site on the UAT server, and sends login credentials to the customer. 
  8. Customer develops productWith support from PKB as required: 
    1. Customer and PKB agree which messages are to be used 
    2. Customer does their necessary development 
    3. PKB does their necessary development 
  9. QA takes place between customer and PKBBefore access to the PKB production is granted, PKB to work with the customer to provide Quality Assurance that the messages are having the intended impact on the PKB system through the REST Test Scripts.
  10. Open up customer firewall for PKB production environment: Customer to open up their firewall for outbound access to the PKB production server, if required.
  11. PKB configures REST API Client ID on productionPKB to provide a production Client ID to the customer.
  12. QA of REST API on PKB production environment: QA of the production test messages, as above.
Comments