Skip to main content
Provider systems and EHRs retrieve data from a SMART Health Link (SHLink) after scanning a QR code or decoding the SHLink payload. The decoded payload contains a url that points to the SMART Health Link resource server. haau3 implements the retrieval protocol defined by the SMART Health Links specification. Depending on the flags present in the decoded SHLink payload, the receiving application retrieves the data using one of two methods.

Retrieval methods

MethodHTTPWhen usedResponse
Direct file requestGETThe SHLink payload contains the U flag. The encrypted file is returned directly.application/jose
Manifest requestPOSTNo U flag is present. The server returns a manifest describing one or more encrypted files.application/json

Choose a method

Direct file request (GET)

Retrieve the encrypted payload directly when the SHLink payload contains the U flag.

Manifest request (POST)

Retrieve a SMART Health Link manifest when no U flag is present.
To understand the FHIR bundle you get back after decrypting, see Bundle & artifact reference.