Kill the Clipboard - SMART Health Cards Library - v1.0.0
    Preparing search index...

    Interface SHLManifestRequestV1

    Manifest request structure (v1).

    This is the JSON body sent in POST requests to SHL manifest URLs. The recipient field identifies the requesting party, while optional fields provide passcode authentication and embedding preferences.

    const manifestRequest: SHLManifestRequestV1 = {
      recipient: 'Dr. Smith - General Practice',
      passcode: 'user-entered-passcode', // if P flag is set
      embeddedLengthMax: 8192 // prefer files under 8KB embedded
    };

    const response = await fetch(shl.url, {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(manifestRequest)
    });
    interface SHLManifestRequestV1 {
        embeddedLengthMax?: number;
        passcode?: string;
        recipient: string;
    }
    Index

    Properties

    embeddedLengthMax? passcode? recipient

    Properties

    embeddedLengthMax?: number

    Optional upper bound for embedded payload sizes in bytes. Files smaller than this will be embedded in manifest, larger ones use location URLs. Typical values: 4096-32768. Server may ignore or cap this value.

    passcode?: string

    Optional passcode for P-flagged SHLs. Required when SHL has 'P' flag. Server validates against stored hash.

    recipient: string

    Required recipient display string. Identifies the requesting user/system (e.g., "Dr. Smith", "Patient Portal"). Used for logging and audit purposes.

    Settings

    Member Visibility

    On This Page

    Properties