Draft description of custom patient button integration (#258)

* Draft description of custom patient button integration

Joel requested I add this at this particular point int he README.
Both the copy and the location of this information are drafts - any
feedback on them is welcome!

* Fix image paths

* Separate user and integrator parts of the text

* Embiggen the last section title

This will prevent readers from getting the impression it's specific
to the custom patient button section.

* Move custom patient page info to its own guide

* Finish writing a separate guide

* Wording changes and typo fixes.

Thanks for the review, Hagen!

* Update screenshot to match current panel look

* Attempt at relative image links

guides/custom_patient_page.md

@@ -0,0 +1,43 @@
+Custom patient buttons
+======================
+
+Cliniko offers an additional integration option for applications that handle
+patient data. This allows users to open these applications directly from Cliniko
+and potentially synchronize information on a given patient as needed.
+
+How it works for Cliniko users
+-------------------------
+
+Users can add these applications in a settings page under
+Settings > Our clinic > Integrations:
+
+![Configuration
+panel](../assets/custom-patient-buttons-config.png?raw=true)
+
+This adds a new button to the Patient Actions bar for each patient:
+
+![Patient actions with open
+dropdown](../assets/patient-actions-open.png?raw=true)
+
+Clicking on one of those buttons causes the user's browser to send a GET request
+to the corresponding URL, with a query string of `patient_id=<Cliniko ID of
+displayed patient>`. If the user is logged into the other application, they
+should be taken directly to that application's information screen about the
+patient with that Cliniko ID. If they're not logged in, they should be
+redirected to a login screen before they can see the patient information.
+
+How it works for integrators
+-------------------------
+
+If you want your application to integrate with Cliniko in this way, it should
+have an endpoint prepared to receive GET requests from browsers with the query
+string above. Requests made by unauthenticated users should be redirected to a
+login screen. Once the user is authenticated, your application should display
+the information it has about the patient whose Cliniko ID was included in the
+request. If you also integrate with Cliniko via its API, you can have your
+application update its information on that patient via the API at this point.
+
+Once your patient integration endpoint is ready, please get in contact with us
+so we can add its URL to our list of approved applications! Once that's done you
+should be able to publish this URL to your users so they can add it to the
+config panel shown above and use the integration.

readme.md

@@ -281,6 +281,14 @@ API Resources
 * [Treatment Notes](https://github.com/redguava/cliniko-api/blob/master/sections/treatment_notes.md)
 * [Users](https://github.com/redguava/cliniko-api/blob/master/sections/users.md)
 
+Custom Patient Button
+---------------------
+
+Cliniko offers an additional integration option for applications that handle
+patient data. See [this
+guide](https://github.com/redguava/cliniko-api/blob/master/guides/custom_patient_page.md)
+for more details.
+
 Get involved and help make our API better
 -----------------------------------------