Health-Cards

The following topic describes information for the Health-Cards resource.

To interact with the REST endpoints in the Health-Cards resource, see Health-Cards.

Overview

A health card is a verifiable, digital artifact that represents a limited set of information about an individual, relevant to a specific health status. The card can be presented in digital and physical form. A QR code representing the card 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 artifact and its issuer. The goal is to provide individuals with the choice to share limited health information in a portable and secure manner.

Health cards are designed in conformance with the emerging SMART Health Card framework (technical specification) and HL7 FHIR Vaccination and Testing IG.

The $health-cards-issue operation adheres to the FHIR specification and returns health cards as verifiableCredentials in a FHIR Parameters resource. These verifiable credentials are JSON Web Signatures with a compressed payload.

See the specification for details on the protocols for the following actions:

• Encoding and decoding the health cards JWS

• Signing and verifying the JWS

The FHIR Bundle encompassed in the health card adheres to the Data Minimization profiles defined by HL7 FHIR Vaccination and Testing IG.

Supported Health Card Types

Description	FHIR Bundle Profile	Credential Types
COVID-19 vaccination	For more information, see the Vaccination Credentials (DM) section in this topic.	https://smarthealth.cards#health-card https://smarthealth.cards#immunization https://smarthealth.cards#covid19
COVID-19 laboratory test result	For more information, see the Laboratory Test Result Credentials (DM) section in this topic.	https://smarthealth.cards#health-card https://smarthealth.cards#laboratory https://smarthealth.cards#covid19

A supported health card type is returned if the following conditions are met:

• The intersection of the requested credential types matches the credential types of the health card type

• The system contains valid data to satisfy the health card types FHIR Bundle profile

Supported FHIR Bundle Profiles

Below are the FHIR Bundle profiles for the resources returned in a health card type.

Vaccination Credentials (DM)

This profile represents the patient and the clinical data related to a vaccination.

The following resources are included:

• A single Patient resource that follows the VaccinationCredentialPatientDM profile with the following fields, if valued:

  • Patient official name

  • Date of Birth

• One or more Immunization resources that follow 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

Terminology Bindings

• Immunization.vaccineCode

  Description: The administered vaccine product.

  Details: CVX

  System: http://hl7.org/fhir/sid/cvx

Authorization Types

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

Laboratory Test Result Credentials (DM)

This profile represents the patient and the clinical data related to a laboratory test result.

The following resources are included:

• A single Patient resource that follows the VaccinationCredentialPatientDM profile with the following fields, if valued:

  • Patient official name

  • Date of Birth

• One or more Observation resources that follow the InfectiousDiseaseLaboratoryResultObservationDM profile with the following fields, if valued:

  • Status

  • Code

  • Subject

  • Effective date time

  • Value (one of)

  • Value codeable concept

  • Value quantity

  • Value string

  • Reference range

Terminology Bindings

• Observation.code

  Description: The codes that identify names of simple observations.

  • Details: LOINC

    System: http://loinc.org

  • Details: LOINC (Covid19)

    System: http://loinc.org

• Observation.valueCodeableConcept

  Description: The codes for the values of the observation.

  Details: SNOMED CT

  System: http://snomed.info/sct

Authorization Types

The OAuth2 token must include Patient.read and Observation.read scopes.