Class SHCIssuer

Issues new SMART Health Cards from FHIR Bundles.

Security Warning: Issue/sign on a secure backend only; never expose the private key in browsers.

Index

Constructors

constructor

Methods

issue

Constructors

constructor

new SHCIssuer(config: SHCConfigParams): SHCIssuer

Creates a new SHCIssuer instance.

Parameters

config: SHCConfigParams
Configuration parameters for the issuer

Returns SHCIssuer

Example

// Using PEM format keys
const issuer = new SHCIssuer({
  issuer: 'https://your-healthcare-org.com',
  privateKey: privateKeyPKCS8String, // ES256 private key in PKCS#8 format
  publicKey: publicKeySPKIString, // ES256 public key in SPKI format
});

// Using JsonWebKey format
const issuerJWK = new SHCIssuer({
  issuer: 'https://your-healthcare-org.com',
  privateKey: { kty: 'EC', crv: 'P-256', x: '...', y: '...', d: '...' },
  publicKey: { kty: 'EC', crv: 'P-256', x: '...', y: '...' },
});

Methods

issue

issue(fhirBundle: FHIRBundle, config?: VerifiableCredentialParams): Promise<SHC>
Issues a new SMART Health Card from a FHIR Bundle.
Parameters
- fhirBundle: FHIRBundle
  FHIR R4 Bundle containing medical data
- config: VerifiableCredentialParams = {}
  Optional Verifiable Credential parameters. See VerifiableCredentialParams.
Returns Promise<SHC>
Promise resolving to SHC object
Throws
CredentialValidationError When FHIR bundle is invalid

Throws
JWSError When signing fails
Example
```
const issuer = new SHCIssuer(config);
const healthCard = await issuer.issue(fhirBundle, {
  includeAdditionalTypes: ['https://smarthealth.cards#covid19']
});
```
- Defined in src/shc/issuer.ts:82

Class SHCIssuer

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SHCIssuer

Example

Methods

issue

Parameters

Returns Promise<SHC>

Throws

Throws

Example

Settings

On This Page