SMART Health Cards

SMART Health Cards Workflow (BETA)

Overview of SMART Health Cards 
SMART Health Cards provide individuals with the choice to share limited health information in a portable and secure manner. These cards are paper or digital versions of clinical information, such as vaccination history. The card has a 2D barcode (QR Code) that can be shared from a device or a piece of paper. Information in the health card can be used to determine the authenticity of the data and its issuer.

SMART® Health Card framework standard is open, interoperable, and built on top of the HL7 FHIR standard.
To obtain the JSON that makes up the QR code, the FHIR specification has defined a FHIR operation $health-cards-issue which returns Patient and Immunization data in JSON format.

Implementation Note:

  • Although the API URL says dstu2, the data returned is R4 FHIR according to the vaccine credential initiative FHIR implementation guide.
  • Though the spec is considered stable, it has yet to undergo the HL7 FHIR balloting process that may introduce changes. Please consider this when implementing it in a Production environment.

The endpoint above will return the following Bundle profiles:

Vaccine Credentials (DM)

The operation returns the following information:

  • A Patient resource following the VaccinationCredentialPatientDM profile with the following fields, if valued:
    • Patient name
    • Date of birth
  • One or more Immunizations resources following the VaccinationCredentialImmunizationDM profile with the following fields, if valued:
    • Status
    • Vaccine administered
    • Patient
    • Administration date/time
    • Vaccine lot number
    • Performer - Organization that performed the action

Authorization
The OAuth2 token must include Patient.read and Immunization.read scopes.

Credential Types
To successfully return a HealthCard, the API requires both the covid19 and health-card credential types in the POST body.

Example POST Request

{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"credentialType",
         "valueUri":"https://smarthealth.cards#health-card"
      },
      {
         "name":"credentialType",
         "valueUri":"https://smarthealth.cards#covid19"
      }
   ]
}

Example API Response

{
   "parameter":[
      {
         "name":"verifiableCredential",
         "valueString": "eyJ6aXAiOiJERUYiLCJraWQiOiJtb0p2LWNfbHBmQ1hwTm1UdW5nZ3hreDRMVVF3YTJaakZPNzIyS3NtM0g4IiwiYWxnIjoiRVMyNTYifQ.5VPJbttADP0X9mprqxvDOjZFgV6KAlkuUQ6jGcqadhZhFjWO4X8PZ-QESYugH1BAB_GRfHx8oo4wc2iPwB0KNEEydRX7n8hDAodRus_RCIUporQ7QHt3BIfeRscz2ksXxi8sUABNVVXrqqYHVi9F14cp5X6wIImBEoZpzDR7OaOhN_hKc9gk4X4FA9NS0RS40swFOBG0RyPQERTNL2N_GzhRWVTqxikCn8e0FeFvpc2Mc2nw0oocciuk2efJ_uADauoeQ5jaruzKUW0L6_ZdmXbuSi9FV_L5geTy3E67bUkNjVY2fI-6z4rq5uPfm37TOhr5SPtaQ9npvHibxA3o0CR1b3WDDyxETzC3elIYUFCn5Ty6XJ_8vZZ60dGQwZ_WTfOOD_X_5UNVv-NDk4_nD03na15BWGJulaJjTwoTC-18i86nsIVNURWZfKm9A0rJQbJe4eXL30JUyTufzfPpZkdkKowFZ074D0uwTsE_Krmdpah3kKw1
_QBtfdFsds1us71YgfT-_JGW9iS0MNZMzoqCEZFhhbRn2vWroR5OTw.Cpnr7-jdGFj3JVqIR7uu8IR5Xz7MpOIZFzeAYtBgZ6FQDL49CN9enVQH5NyZNmy2AWK9XPdzvW2quT48xrmNhA"
      }
   ],
   "resourceType":"Parameters"
}

_since Parameter
By default, the data returned is of any age. To request data from after a certain point in time, supply the _since parameter with a valueDateTime.

Example POST Request with _since Parameter

{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"credentialType",
         "valueUri":"https://smarthealth.cards#health-card"
      },
      {
         "name":"credentialType",
         "valueUri":"https://smarthealth.cards#covid19"
      },
      {
         "name":"_since",
         "valueDateTime":"2021-05-01"
      }
   ]
}

Consuming Health Cards
How to create the QR code given the Health Card JWS response: https://spec.smarthealth.cards/#creating-a-qr-code-or-a-set-of-qr-codes-from-a-health-card-jws

Reference links:

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit