Class SmartHealthCardReader

Reads and verifies SMART Health Cards from various sources.

Index

Constructors

Methods

fromFileContent fromJWS

Constructors

constructor

new SmartHealthCardReader(
config: SmartHealthCardReaderConfigParams,
): SmartHealthCardReader
Creates a new SmartHealthCardReader instance.
Parameters
- config: SmartHealthCardReaderConfigParams
  Configuration parameters for the reader
Returns SmartHealthCardReader
Example
```
const reader = new SmartHealthCardReader({
  publicKey: publicKeySPKIString, // ES256 public key in SPKI format
});
```
- Defined in src/index.ts:660

Methods

fromFileContent

fromFileContent(fileContent: string | Blob): Promise<SmartHealthCard>
Read and verify a SMART Health Card from file content.
Parameters
- fileContent: string | Blob
  File content as string or Blob from .smart-health-card files
Returns Promise<SmartHealthCard>
Promise resolving to verified SmartHealthCard object

Throws
FileFormatError If the file is not valid JSON or missing the verifiableCredential array

Throws
JWSError If the embedded JWS is malformed or signature verification fails (propagated from fromJWS)

Throws
FhirValidationError If the decoded VC payload or embedded FHIR Bundle is invalid (propagated from fromJWS)

Throws
VerificationError For unexpected errors during verification (propagated from fromJWS)
- Defined in src/index.ts:682

fromJWS

fromJWS(jws: string): Promise<SmartHealthCard>
Read and verify a SMART Health Card JWS.
Parameters
- jws: string
  JWS string to verify
Returns Promise<SmartHealthCard>
Promise resolving to verified SmartHealthCard object

Throws
JWSError If the JWS is malformed, signature verification fails, or the public key cannot be imported

Throws
FhirValidationError If the decoded VC payload or embedded FHIR Bundle is invalid

Throws
VerificationError For unexpected errors during verification
- Defined in src/index.ts:732