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

    Interface SHCConfigParams

    Configuration parameters for SHCIssuer.

    interface SHCConfigParams {
        enableQROptimization?: boolean;
        expirationTime?: null | number;
        issuer: string;
        privateKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | JsonWebKey;
        publicKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | JsonWebKey;
        strictReferences?: boolean;
    }
    Index

    Properties

    enableQROptimization? expirationTime? issuer privateKey publicKey strictReferences?

    Properties

    enableQROptimization?: boolean

    Whether to optimize FHIR Bundle for QR codes by using short resource-scheme URIs (resource:0, resource:1, etc.) and removing unnecessary fields.

    true

    expirationTime?: null | number

    Optional expiration time in seconds from now. If null, health cards will not have an expiration (exp claim).

    null

    issuer: string

    Issuer URL identifying the organization issuing the health card. This value appears in the JWT iss claim.

    privateKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | JsonWebKey

    ES256 private key for signing health cards. Can be a WebCrypto CryptoKey, raw bytes as Uint8Array, PEM-formatted string, or JsonWebKey object.

    publicKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | JsonWebKey

    ES256 public key corresponding to the private key. Used for key ID (kid) derivation per SMART Health Cards specification.

    strictReferences?: boolean

    Whether to enforce strict reference validation during QR optimization. If true, throws error for missing bundle references. If false, preserves original references when target resource is not found.

    true

    Settings

    Member Visibility

    On This Page

    Properties