This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Health Cards Change Log

Below is a log of changes to the SMART Health Cards specification prior to it becoming an HL7 standard. The version numbers below were assigned by the Verifiable Credential Information coalition (VCI).

VCI 1.4.0

Deprecate "additional" top-level types like #covid19, #laboratory, and #immunization in favor of classifying cards based on their contents.

VCI 1.3.0

• Deprecate "QR chunking" protocol, which has not seen wide adoption in real products and does not support a clean UX for presentation. For SHCs that need to be presented as QRs, we recommend limiting payload size to fit in a single QR (when possible), or else considering SMART Health Links.
• Ensure that SHCs can be used for patient summary documents
  • any FHIR Bundle.type is allowed
• Update introduction to reflect current status

VCI 1.2.3

Clarify that payload size restrictions apply when SHCs are intended for presentation as QRs

VCI 1.2.2

Update examples to include 3-dose COVID vaccination histories

VCI 1.2.1

Documented optional exp claim for expiration

VCI 1.2.0

Specified Health Card revocation

VCI 1.1.1

Added verifier guidance to ignore unrecognized VC types

VCI 1.1.0

Updated TLS requirements for issuer key set

VCI 1.0.2

Updated links to the HL7 Implementation Guide

VCI 1.0.1

Clarify FHIR API behavior when $health-cards-issue doesn't return results

VCI 1.0.0

No functional change from 1.0.0-rc; added documentation links and re-worked introduction.

VCI 1.0.0-rc

No change from 0.4.5; applying tag for connectathon release

VCI 0.4.5

Clarify mapping into VC Data Model, and strip "fixed" fields from payload

VCI 0.4.4

Resource.meta is allowed in one special case

VCI 0.4.3

Document CORS expectation for .well-known/jwks.json

VCI 0.4.2

Replace iat with nbf in JWT payload encoding

VCI 0.4.1

Added optional x5c in JWKS

VCI 0.3.1

Add optional vcIndex param on $health-cards-issue response's resourceLink

VCI 0.3.0

Rename $HealthWallet.issueVc to $health-cards-issue

VCI 0.2.0

Chunk-based QR representation of larger Health Cards (JWS > 1195 characters). Defines shc:/<n>/<c>/ prefix, where <n> represents a chunk number and <c> represents the total chunk count.

VCI 0.1.1

Added shc:/ prefix for QR representations.

VCI 0.1.0

Significant API overhaul to reduce scope and simplify dependencies. See PR#64 for details.

• Remove user DIDs from the picture. They were already optional, and in some of our most important flows unlikely to be available.

• Remove the need to bind an issuer to a holder ahead of time. SMART on FHIR clients can now call $HealthWallet.issueVc without having to call $HealthWallet.connect first

• Update $HealthWallet.issueVc response to use valueString (avoids the need for base64 encoding in the FHIR Parameters resource)

• Replace DID-based key discovery with hosted JSON Web Key. Establish the requirement that Issuers host .well-known/jwks.json

• Define requirements for keeping Health Cards' JWS representation small (small enough to fit in a QR code) – including size limits and a method for splitting a Health Card into a Health Card Set when the size limit cannot be met

• Document process for embedding Health Cards in QR codes

• Update file extension and MIME type for representing Health Cards as downloadable files (.smart-health-card and application/smart-health-card)

• Remove SIOP flow For Verifier::Holder communications

VCI 0.0.12

Add optional resourceLink response parameter on $HealthWallet.issueVc

VCI 0.0.11

Change canonical domain to https://smarthealth.cards (from https://healthwallet.cards)

VCI 0.0.10

Add detail on how to recognize encryption keys, signing keys, and linked domains in a DID Document

VCI 0.0.9

Add discovery params to .well-known/smart-configuration, allowing SMART on FHIR servers to advertise Health Cards capabilities

VCI 0.0.8

• Clarify that .fhir-backed-vc files can contain JWS- or JWE-based VCs
• Update JWS signature algorithm to ES256

VCI 0.0.7

Simplify demographics recommendations with one uniform "minimum set"

VCI 0.0.6

Updated encryption to use "alg": "ECDH-ES" (with "enc": "A256GCM")

VCI 0.0.5

Updated encryption to use "enc": "A256GCM"

VCI 0.0.4

• Added links to overview / intro video
• Updated SIOP request to identify requested credentials by type URL (https://healthwallet.cards#covid19 instead of health-wallet-covid19-card)

VCI 0.0.3

• Update .well-known DID links and file URL to match latest spec

VCI 0.0.2

• Use valueUri (which exists in DSTU2+) for FHIR datatypes rather than valueUrl (which was introduced after DSTU2)
• Added encryptForKeyId parameter to $HealthWallet.issueVc operation, defaulting to absent == no encryption
• Updated example VC JWT representations to ensure that the .vc.credentialSubject contains all subject-specific claims
• Defined OperationOutcome payload for failed $HealthWallet.issueVc operations