Sessions and links
How to get a Hosted Pages URL for a patient, and how to choose depending on whether Awell or the integrating system decides the timing.
Both Hosted Pages links and sessions solve the same problem: a care flow has produced an activity that needs someone's attention, and that person needs a URL where they can complete it. The two differ in who decides when that URL comes into existence.
A link fits when enrollment and access happen at once
Awell generates a link for a published care flow. Put it wherever patients will find it: a button on the site, an email, a QR code.
Someone clicks, a care flow starts, and they land in their first activity. See Trigger with a Hosted Pages link.
A session fits when the integrating system controls the handover
Create a session through the API and get back a session URL.
Use a session when the patient already exists, the care flow is already running, and a specific person has to be handed into a specific activity from inside the integrating application.
See Hosted sessions in the API reference.
Start with a link; move to sessions when the app must control timing
| Hosted Pages link | Session | |
|---|---|---|
| Created by | Awell, per care flow | The integrating system, per handover |
| Starts a care flow | Yes | No, the flow already exists |
| Control over timing | Whoever clicks | The integrating application |
| Effort | Almost none | An API call |
A session adds an API call, which is worth it when only the integrating system knows the right moment.
Next steps
Next: Embed or redirect once a URL exists.
Built-in and customizable features
What Hosted Pages provides by default, from accessibility and internationalization to form auto-save, and which parts are configurable.
Embed or redirect to Hosted Pages
Put Hosted Pages in an iframe inside a host app, or send the stakeholder to it, and control where they end up when they finish.