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

    Interface SHCReaderConfigParams

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

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

    Properties

    enableQROptimization? issuerDirectory? publicKey? strictReferences? useVciDirectory? verifyExpiration?

    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

    issuerDirectory?: null | Directory

    Optional pre-fetched Directory instance containing issuer metadata (JWKS keys and optional CRLs). Pass null to explicitly indicate no directory is available.

    null

    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

    useVciDirectory?: boolean

    Whether to consult the VCI directory to resolve issuer metadata (JWKS and related information). When true, the reader will attempt to resolve keys from the VCI directory during verification. When false, no automatic VCI directory lookup will be performed.

    false

    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

    Settings

    Member Visibility

    On This Page

    Properties