SpotlightSMART Health Links

Share records with a link or a QR code.

Create encrypted SMART Health Links that patients hand to a clinician or another app. Set an expiry, add a passcode, revoke any link and see who opened it.

Included from Omni · $5,000/year on lower plans · Read the docs

Records in your app
  • Lab results
  • Medications
  • Insurance card
Shared as
  • shlink:/ URL
  • QR code
  • Viewer link

01The short answer

What is a SMART Health Link?

A SMART Health Link is an encrypted shlink:/ URL, often shown as a QR code, that carries health information such as a SMART Health Card, a FHIR Bundle or a digital insurance card. The receiving app decrypts the data locally with a key embedded in the link.

Flexpa's API implements the SMART Health Cards and Links STU1 specification. Each link is encrypted with a unique 32-byte key that Flexpa does not store, and you control the lifetime, passcode and revocation of every link you create.

02How it works

From connection to result

  1. 1

    Get an application token

    Your server authenticates with the client credentials grant.

  2. 2

    Create the link

    POST the files to share: a SMART Health Card, a FHIR Bundle or SMART API access. Add a label, a lifetime and, if you want one, a passcode.

  3. 3

    Show it to the patient

    The response includes the shl, a viewerUrl and a manifestUrl. Render the shl as a QR code or send it as a link.

  4. 4

    Stay in control

    List your links, see usage stats and the access log for each one, and revoke any link at any time.

Create a link from a FHIR Bundle
curl -X POST https://api.flexpa.com/smart/health-links \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "contentType": "application/fhir+json",
        "content": { "resourceType": "Bundle", "type": "collection", "entry": [] }
      }
    ],
    "user": { "externalId": "patient-456" },
    "label": "Visit summary",
    "ttl": 86400
  }'

Good to know

  • Passcodes are optional. They run 5 to 128 characters, lock after 3 failed attempts and cannot be combined with direct transfer.
  • Labels are limited to 80 characters and are visible without the passcode, so keep health information out of them.
  • Each link can carry up to 10MB.
  • Links expire after their ttl unless you create them as long-term links.

03Who it's for

Where it pays off

Health apps and devices

Let users carry their records to their next visit, so your product becomes part of their care.

See health apps and devices

Kill the clipboard

Share records at check-in with a QR code instead of a paper intake form.

See Kill the Clipboard

New patient intake

Receive a new patient’s history before the first appointment.

Read the guide

Plans

Included in Omni and above

SMART Health Links is included in the Omni and Infrastructure plans. On Startup, Growth and Scale, it is $5,000 a year.

04A few good questions

SMART Health Links,
answered.

Can Flexpa read the shared data?

Flexpa encrypts the payload and stores the encrypted copy. The decryption key lives in the link itself and is not persisted by Flexpa.

Can I take a link back?

Yes. Revoke it with a DELETE request and it stops working.

Can I see who opened a link?

Yes. Each link has an access log you can read through the API.

How is a link different from a SMART Health Card?

A SMART Health Card is a signed, verifiable credential. A SMART Health Link is the encrypted way to share one or more cards, plus other FHIR data.

Which Flexpa plans include SMART Health Links?

SMART Health Links is included in the Omni and Infrastructure plans. On Startup, Growth and Scale, it is $5,000 a year.

Kill the clipboard, one link at a time.

See the records a patient can share, then talk to us about putting links in your product.

Get a demo