The Cicada Vaccine Forecasting Engine and Guide
0.1.0 - ci-build

The Cicada Vaccine Forecasting Engine and Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Allergy Intolerance Profile for Immunization Decision Support

Profile for allergy intolerances relevant to immunization. The code (allergen/substance) may use SNOMED CT or ICD-10-CM. Reaction substances may use CVX, MVX, SNOMED CT, or RxNorm.

Condition Profile with Vaccine Condition Codes

Profile for conditions where the code must be from the Vaccine Condition Codes value set. Accepts SNOMED CT and ICD-10-CM coded conditions.

Dose of a Vaccine

Detailed information about each vaccination dose.

Immunization Procedures Profile

Profile for medical procedures related to immunization based on SNOMED CT or CPT codes.

Medication Administration Profile with Vaccine Codes

Profile for medication administrations with vaccine codes from CVX or MVX.

Medication Dispense Profile with Vaccine Codes

Profile for medication dispenses with vaccine codes from CVX or MVX.

Medication Request Profile with Vaccine Codes

Profile for medication requests with vaccine codes from CVX or MVX.

Medication Statement Profile with Vaccine Codes

Profile for medication statements with vaccine codes from CVX or MVX.

Observation Profile for Immunization Decision Support

Profile for Observation resources carrying lab evidence of immunity or other findings relevant to immunization decisions. Codes may be from SNOMED CT, ICD-10-CM, or LOINC.

Vaccination Patient

A profile that extends the base FHIR Patient resource to include detailed vaccination-related information.

Vaccine

Simple vaccine to easily obtain needed information for forecasting

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Allowed Interval Reason

Captures the reason for the allowed interval between vaccine doses.

Allowed Interval Status

Captures the status of the allowed interval for vaccination.

Allowed Vaccine Reason

Captures the reason why a particular vaccine is allowed.

Allowed Vaccine Status

Indicates if the vaccine administered is allowed under certain conditions.

AssessmentDate

The date on which the vaccination assessment was made.

Begin Age

The age at which the vaccine becomes applicable.

End Age

The age at which the vaccine is no longer applicable.

Inadvertent Administration Status

Indicates if the vaccine was administered inadvertently.

Preferred Interval Reason

Captures the reason for the preferred interval between vaccine doses.

Preferred Interval Status

Indicates if the vaccine was administered at the preferred interval.

Preferred Vaccine Reason

Captures the reason why a particular vaccine is preferred.

Preferred Vaccine Status

Indicates if the vaccine administered is the preferred vaccine.

Vaccination Conflict

Indicates any conflicts with other vaccinations.

Vaccine Type

Type of the vaccine.

Valid Age Reason

Captures the reason why the vaccine was administered at a particular age.

Valid Age Status

Indicates if the vaccine was administered at the correct age.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Evaluation Reason

The reason for the evaluation.

Evaluation Status Value Set

Value Set for the status of the result of an evaluation.

Immunization-Relevant Medications (RxNorm)

RxNorm codes for medications relevant to immunization decision support, including antivirals and aspirin.

Immunization-Relevant Procedures (CPT)

CPT codes for procedures relevant to immunization decision support, including splenectomy and cochlear implant.

Interval Reason

This value set includes codes for the reason an interval is considered to be invalid.

Lab Evidence of Immunity (LOINC)

LOINC codes for laboratory tests that provide evidence of immunity, mapped to CDSi observation codes for immunization decision support.

Medications

Value set for medications and substances based on SNOMED CT, including both active ingredients and marketed products.

Procedures

Comprehensive Value Set for medical procedures based on SNOMED CT codes.

Reasons why certain doses are Preferred or Allowed doses

Reasons why certain doses are Preferred or Allowed doses

Vaccine Condition Codes

Value set for conditions based on SNOMED CT, that may impact immunization.

Vaccine Condition Codes (ICD-10-CM)

Value set for conditions based on ICD-10-CM that may impact immunization decisions, mapped to CDSi observation codes.

Vaccine Gender

Value set for gender categories relevant to vaccination data.

VaccineCodesCvxMvx
Valid Age Reason

Value set for reasons why a patient's age is considered valid/invalid for a vaccine.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CDSI Observation Codes

Observations and Conditions that are important to indications or contraindications in vaccine forecasting

Evaluation Reason

The reason for the evaluation.

Evaluation Status

The status of the result of an evaluation.

Interval Reason

This value set includes codes for the reason an interval is considered to be invalid.

Reasons why certain doses are Preferred or Allowed doses

Reasons why certain doses are Preferred or Allowed doses

Vaccine Gender

Value set for gender categories relevant to vaccination data.

Valid Age Reason

Value set for reasons why a patient's age is considered valid/invalid for a vaccine.

Terminology: Structure Maps

These define transformations to convert between data structures used by systems conforming to this implementation guide.

MapVaccineCodes

Define the usage of FHIR resource types with specific aliases

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

ICD-10-CM to CDSi Observation Code Map

Maps ICD-10-CM diagnosis codes to CDSi observation codes used in immunization decision support.

SNOMED CT to CDSi Observation Code Map

Maps SNOMED CT codes to CDSi observation codes used in immunization decision support.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Antigen Supporting Data

A resource to store supporting data for antigens including target disease, vaccine groups, immunity criteria, contraindications, and vaccination series.

Schedule Supporting Data

This resource consolidates various mapping and conflict information related to vaccine scheduling to support decision-making processes.