Immunization Incubator Implementation Guide
0.1.0 - International flag

Immunization Incubator Implementation Guide, published by HL7 International / Public Health. 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/HL7/immunization-incubator/ and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

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

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

ImmunizationEvaluationDateSearchParam

Date the evaluation was generated
ImmunizationEvaluationDose-statusSearchParam

The status of the dose relative to published recommendations
ImmunizationEvaluationIdentifierSearchParam

ID of the evaluation
ImmunizationEvaluationImmunization-eventSearchParam

The vaccine administration event being evaluated
ImmunizationEvaluationPatientSearchParam

The patient being evaluated
ImmunizationEvaluationStatusSearchParam

Immunization evaluation status
ImmunizationEvaluationTarget-diseaseSearchParam

The vaccine preventable disease being evaluated against
ImmunizationRecommendationDateSearchParam

Date recommendation(s) created
ImmunizationRecommendationIdentifierSearchParam

Business identifier
ImmunizationRecommendationInformationSearchParam

Patient observations supporting recommendation
ImmunizationRecommendationPatientSearchParam

Who this profile is for
ImmunizationRecommendationStatusSearchParam

Vaccine recommendation status
ImmunizationRecommendationSupportSearchParam

Past immunizations supporting recommendation
ImmunizationRecommendationTarget-diseaseSearchParam

Disease to be immunized against
ImmunizationRecommendationVaccine-typeSearchParam

Vaccine or vaccine group recommendation applies to

Structures: Additional Resources

'Additional' resources that are not yet published in the FHIR core specification.

Immunization Evaluation

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.
Immunization Recommendation

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Terminology: Value Sets

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

Immunization Evaluation Dose Status Reason codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the reason why an administered dose has been assigned a particular status. Often, this reason describes why a dose is considered invalid. This value set is provided as a suggestive example.
Immunization Evaluation Dose Status codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the validity of a dose relative to a particular recommended schedule. This value set is provided as a suggestive example.
Immunization Evaluation Status Codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the evaluation for vaccine administration event.
Immunization Recommendation Date Criterion Codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support the definition of dates relevant to recommendations for future doses of vaccines. This value set is provided as a suggestive example.
Immunization Recommendation Reason Codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the reasons why a given recommendation status is assigned. This value set is provided as a suggestive example and includes SNOMED CT concepts.
Immunization Recommendation Status Codes

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the status of the patient towards perceived immunity against a vaccine preventable disease. This value set is provided as a suggestive example.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

example
example
example-target-disease
notValid

Other

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

ImmunizationEvaluation-examples
ImmunizationEvaluation-operations
ImmunizationRecommendation-examples
ImmunizationRecommendation-operations