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

    Interface SHCReaderConfigParams

    Configuration parameters for SHCReader. Reader configuration only needs public key for verification.

    interface SHCReaderConfigParams {
        enableQROptimization?: boolean;
        publicKey?:
            | null
            | string
            | Uint8Array<ArrayBufferLike>
            | CryptoKey
            | JsonWebKey;
        strictReferences?: boolean;
        verifyExpiration?: boolean;
    }
    Index

    Properties

    enableQROptimization?: boolean

    Whether to optimize FHIR Bundle for QR codes when reading health cards. Should match the issuer's setting for proper reconstruction.

    true

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

    ES256 public key for verifying health card signatures. Can be a WebCrypto CryptoKey, raw bytes as Uint8Array, PEM-formatted string, or JsonWebKey object.

    strictReferences?: boolean

    Whether to enforce strict reference validation during optimization. Should match the issuer's setting for proper reconstruction.

    true

    verifyExpiration?: boolean

    Whether to verify the JWT exp claim during verification. When true (default), expired health cards will be rejected. Set to false to allow expired cards to be accepted.

    true