SMART Health Cards: Terminology
0.1.0 - ci-build
SMART Health Cards: Terminology, published by VCI. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/dvci/shc-terminology/ and changes regularly. See the Directory of published versions
Official URL: https://terminology.smarthealth.cards/ImplementationGuide/cards.smarthealth.terminology | Version: 0.1.0 | |||
Draft as of 2024-11-22 | Computable Name: SMARTHealthCardsTerminology |
This website is a community-maintained terminology resource for implementers of SMART Health Cards.
It provides both human-readable terminology resources, as well as computable versions in the form of JSON representations of FHIR Resources.
FHIR Implementation Guides (IGs) are used to specify the FHIR payload within SMART Health Cards.
The SMART Health Cards: Vaccination & Testing Implementation Guide describes the patient information and clinical data contained in SMART Health Cards related to vaccinations and qualitative laboratory testing for infectious diseases. Terminology relevant to these use cases is described in the table below.
Type | Description | Relevant terminology |
---|---|---|
Immunization | COVID-19 immunization |
Identifying vaccines: A unified ValueSet combining the above is provided for convenience. |
Immunization | Orthopoxvirus (smallpox and mpox) immunization |
Identifying vaccines:
A unified ValueSet combining the above is provided for convenience. |
Immunization | Any immunization |
Identifying vaccines: |
Observation | COVID-19 qualitative laboratory test |
Identifying laboratory tests: |
Observation | Qualitative laboratory test results for infectious diseases (including COVID-19) |
Identifying laboratory test results: |
The codes in this CodeSystem may be used by Issuers of SMART Health Cards to record if/how a patient's identity was verified at the point of care. For example, if a patient showed their driver's license to verify their name and date of birth when getting a vaccination, this would correspond to IAL1.4
.
#health-card
SMART Health Cards are identified by a vc.type
value of https://smarthealth.cards#health-card
, which is defined in this CodeSystem. See the SMART Health Cards specification for more information.
ValueSets from medical terminology (e.g., CVX, LOINC, etc.) are versioned using a YYYY.n
format where YYYY
is the year a given version was created and n
is an incremented integer.
Unified terminology ValueSets (e.g., all COVID-19 vaccine codes) are versioned with the date they were generated (e.g., 20230101
for generation on Jan 1, 2023).
Other terminology resources are versioned with semantic versioning.
(Semantic versioning is not used for the medical terminology ValueSets because that there is no notion of "incompatible" changes, meaning that the first semantic versioning digit representing the "major" version would never be incremented. This would eventually lead to version numbers like 1.1234.0
.)
For technical questions, please post on the smart/health-cards Zulip stream at chat.fhir.org (free account required).
This website is maintained for the SMART Health Card implementer community by VCI.
The source code for this website and the FHIR resources contained within are available on GitHub, and community contributions are welcome. Please see https://github.com/dvci/shc-terminology/ for details.