{"type":"doc","content":[{"type":"paragraph","content":[{"text":"It is possible for organisations to enable a workflow to send SMS to unregistered patients upon receiving a referral letter in their record.","type":"text"}]},{"type":"paragraph","content":[{"text":"To do so, we need:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"an employee to enable the workflow on the UI for the org (cf ","type":"text"},{"text":"this guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.patientsknowbest.com/space/MAN/4581294112/Gov.notify+for+sending+text+messages+(SMS)+-+IN+DRAFT"}}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PKB / the org themselves to set up a new service on ","type":"text"},{"text":"GOV.UK","type":"text","marks":[{"type":"link","attrs":{"href":"http://GOV.UK"}}]},{"text":" Notify API webpage (cf ","type":"text"},{"text":"this guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.patientsknowbest.com/space/MAN/4581294112/Gov.notify+for+sending+text+messages+(SMS)+-+IN+DRAFT"}}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"a dev to add the credentials and sms setup into the database","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"This page covers the last bullet point. To create new credential and sms properties, the notification service exposes some controllers. (see ","type":"text"},{"text":"NotifyCredentialsController","type":"text","marks":[{"type":"code"}]},{"text":"and ","type":"text"},{"text":"NotifySmsPropertiesController","type":"text","marks":[{"type":"code"}]},{"text":") Hence, we only need to send requests with the right parameters to the notification service using curl.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 1: connecting to the right cluster","type":"text"}]},{"type":"paragraph","content":[{"text":"To be able to send requests using curl to the notification service, we need to connect to the right cluster and then forward the notificationservice pod port to our localhost.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Connecting to RC","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"gcloud container clusters get-credentials sandbox-2 --zone europe-west2-b --project develop-238811\nkubectl port-forward deployment/notificationservice -n rc 40000:8080","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Connecting to UK Prod","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"gcloud container clusters get-credentials uk-prod-1 --zone europe-west2-c --project prod-239510\nkubectl port-forward deployment/notificationservice -n uk 40000:8080","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 2: sending a request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Create or update credentials for an organisation","type":"text"}]},{"type":"paragraph","content":[{"text":"This is what we use to authenticate to the ","type":"text"},{"text":"gov.uk","type":"text","marks":[{"type":"link","attrs":{"href":"http://gov.uk"}}]},{"text":" notify API. What you need:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the organisation resourceId (","type":"text"},{"text":"Organization/","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the serviceId","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the apiKey","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Both the serviceId and apiKey are created during the set up of the ","type":"text"},{"text":"GOV.UK","type":"text","marks":[{"type":"link","attrs":{"href":"http://GOV.UK"}}]},{"text":" Notify service. (covered in ","type":"text"},{"text":"this guide","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.patientsknowbest.com/space/MAN/4581294112/Gov.notify+for+sending+text+messages+(SMS)+-+IN+DRAFT"}}]},{"text":").","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl -X POST \"localhost:40000/notify-credentials?orgResourceId=&serviceId=&apiKey=\" -H \"Content-Type: application/fhir+json\" -v","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Revoke credentials","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl -X PUT \"localhost:40000/notify-credentials/revoke?orgResourceId=\" -H \"Content-Type: application/fhir+json\" -v","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Create or update sms properties","type":"text"}]},{"type":"paragraph","content":[{"text":"What you need:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the organisation resourceId (","type":"text"},{"text":"Organization/","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the templateId","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"an optional senderId : this allows the org to send SMS from a specific sender display. It is optional. If it is null, the ","type":"text"},{"text":"GOV.UK","type":"text","marks":[{"type":"link","attrs":{"href":"http://GOV.UK"}}]},{"text":" Notify API will use the default sender set up in the service.","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl -X POST \"localhost:40000/notify-sms-properties?orgResourceId=&templateId=&senderId=\" -H \"Content-Type: application/fhir+json\" -v","type":"text"}]},{"type":"paragraph","content":[{"text":"Example without senderId:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X POST \"localhost:40000/notify-sms-properties?orgResourceId=&templateId=\" -H \"Content-Type: application/fhir+json\" -v","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 3: check your call was successful","type":"text"}]},{"type":"paragraph","content":[{"text":"You only need to read the response from the curl call you just made, however, you can also check the new rows were inserted into the db like so:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From intelliJ, start the appropriate SQL Proxy ('Prod UK - Notification Service' or ‘RC - Notification Service’)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Open a console ('UK - notificationservice' or ‘RC - notificationservice’)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run one of these queries to check your calls were successfull","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"sql"},"content":[{"text":"select * from notif.notify_credentials where org_downstream_resource_id = '';\n\nselect * from notif.notify_sms_properties where org_downstream_resource_id = '';","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: if you need to see the history of credentials used you can look into the respective tables in the ‘history’ schema.","type":"text"}]}],"version":1}

Browser not supported