FHIR IG analytics| Package | hl7.fhir.uv.immunization-incubator |
| Resource Type | ImplementationGuide |
| Id | ImplementationGuide-hl7.fhir.uv.immunization-incubator.json |
| FHIR Version | R6 |
| Source | https://build.fhir.org/ig/HL7/immunization-incubator/index.html |
| URL | http://hl7.org/fhir/uv/immunization-incubator/ImplementationGuide/hl7.fhir.uv.immunization-incubator |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-02-05T20:00:22+00:00 |
| Name | ImmunizationAdditionalResources |
| Title | Immunization Incubator Implementation Guide |
| Realm | uv |
| Authority | hl7 |
| Description | A guide that defines ImmunizationEvaluation and ImmunizationRecommendation as Additional Resources in FHIR |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.uv.immunization-incubator
Language: en
The official URL for this implementation guide is:
http://hl7.org/fhir/uv/immunization-incubator/ImplementationGuide/hl7.fhir.uv.immunization-incubator
A guide that defines ImmunizationEvaluation and ImmunizationRecommendation as Additional Resources in FHIR
FHIR
FHIRsmith{
"resourceType": "ImplementationGuide",
"id": "hl7.fhir.uv.immunization-incubator",
"language": "en",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
}
],
"url": "http://hl7.org/fhir/uv/immunization-incubator/ImplementationGuide/hl7.fhir.uv.immunization-incubator",
"version": "0.1.0",
"name": "ImmunizationAdditionalResources",
"title": "Immunization Incubator Implementation Guide",
"status": "active",
"date": "2026-02-05T20:00:22+00:00",
"publisher": "HL7 International / Public Health",
"contact": [
{
"name": "HL7 International / Public Health",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pher"
},
{
"system": "email",
"value": "pher@lists.HL7.org"
}
]
}
],
"description": "A guide that defines ImmunizationEvaluation and ImmunizationRecommendation as Additional Resources in FHIR",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"packageId": "hl7.fhir.uv.immunization-incubator",
"license": "CC0-1.0",
"fhirVersion": [
"6.0.0-ballot3"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r5",
"version": "7.0.1"
},
{
"id": "hl7ext",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
}
],
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r5",
"version": "5.2.0"
}
],
"definition": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency",
"valueCode": "hl7.fhir.r5.examples"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r5#0.9.0"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-evaluation-dose-status"
},
"name": "Immunization Evaluation Dose Status codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-evaluation-dose-status-reason"
},
"name": "Immunization Evaluation Dose Status Reason codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-evaluation-status"
},
"name": "Immunization Evaluation Status Codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-recommendation-date-criterion"
},
"name": "Immunization Recommendation Date Criterion Codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-recommendation-reason"
},
"name": "Immunization Recommendation Reason Codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/immunization-recommendation-status"
},
"name": "Immunization Recommendation Status Codes",
"description": "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.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ImmunizationEvaluation"
}
],
"reference": {
"reference": "ImmunizationEvaluation/immunization-evaluation-invalid"
},
"name": "ImmunizationEvaluation - Invalid Example",
"description": "An example of an administration event which was found to be invalid.",
"isExample": true,
"profile": [
"http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ImmunizationEvaluation"
}
],
"reference": {
"reference": "ImmunizationEvaluation/immunization-evaluation-valid"
},
"name": "ImmunizationEvaluation - Valid Example",
"description": "An example of an administration event which was found to be valid.",
"isExample": true,
"profile": [
"http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ImmunizationRecommendation"
}
],
"reference": {
"reference": "ImmunizationRecommendation/immunization-recommendation-by-target-disease"
},
"name": "ImmunizationRecommendation - By Target Disease Example",
"description": "An example of an immunization recommendation by target disease.",
"isExample": true,
"profile": [
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ImmunizationRecommendation"
}
],
"reference": {
"reference": "ImmunizationRecommendation/immunization-recommendation-by-vaccine-code"
},
"name": "ImmunizationRecommendation - By Vaccine Code Example",
"description": "An example of an immunization recommendation by vaccine code.",
"isExample": true,
"profile": [
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resourcedefn"
}
],
"reference": {
"reference": "StructureDefinition/ImmunizationEvaluation"
},
"name": "Immunization Evaluation",
"description": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those recommendations."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resourcedefn"
}
],
"reference": {
"reference": "StructureDefinition/ImmunizationRecommendation"
},
"name": "Immunization Recommendation",
"description": "A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-date"
},
"name": "ImmunizationEvaluationDateSearchParam",
"description": "Date the evaluation was generated"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-dose-status"
},
"name": "ImmunizationEvaluationDose-statusSearchParam",
"description": "The status of the dose relative to published recommendations"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-identifier"
},
"name": "ImmunizationEvaluationIdentifierSearchParam",
"description": "ID of the evaluation"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-immunization-event"
},
"name": "ImmunizationEvaluationImmunization-eventSearchParam",
"description": "The vaccine administration event being evaluated"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-patient"
},
"name": "ImmunizationEvaluationPatientSearchParam",
"description": "The patient being evaluated"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-status"
},
"name": "ImmunizationEvaluationStatusSearchParam",
"description": "Immunization evaluation status"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationEvaluation-target-disease"
},
"name": "ImmunizationEvaluationTarget-diseaseSearchParam",
"description": "The vaccine preventable disease being evaluated against"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-date"
},
"name": "ImmunizationRecommendationDateSearchParam",
"description": "Date recommendation(s) created"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-identifier"
},
"name": "ImmunizationRecommendationIdentifierSearchParam",
"description": "Business identifier"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-information"
},
"name": "ImmunizationRecommendationInformationSearchParam",
"description": "Patient observations supporting recommendation"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-patient"
},
"name": "ImmunizationRecommendationPatientSearchParam",
"description": "Who this profile is for"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-status"
},
"name": "ImmunizationRecommendationStatusSearchParam",
"description": "Vaccine recommendation status"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-support"
},
"name": "ImmunizationRecommendationSupportSearchParam",
"description": "Past immunizations supporting recommendation"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-target-disease"
},
"name": "ImmunizationRecommendationTarget-diseaseSearchParam",
"description": "Disease to be immunized against"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/ImmunizationRecommendation-vaccine-type"
},
"name": "ImmunizationRecommendationVaccine-typeSearchParam",
"description": "Vaccine or vaccine group recommendation applies to"
}
],
"page": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}
],
"sourceUrl": "toc.html",
"name": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}
],
"sourceUrl": "index.html",
"name": "index.html",
"title": "IG Home",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}
],
"sourceUrl": "changes.html",
"name": "changes.html",
"title": "Change Log",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}
],
"sourceUrl": "background.html",
"name": "background.html",
"title": "Background",
"generation": "markdown"
}
]
},
"parameter": [
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "copyrightyear"
},
"value": "2025+"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "releaselabel"
},
"value": "ci-build"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/resources/immunizationevaluation"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/resources/immunizationrecommendation"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "additional-resource"
},
"value": "input/resources/immunizationevaluation/StructureDefinition-ImmunizationEvaluation.xml"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "additional-resource"
},
"value": "input/resources/immunizationrecommendation/StructureDefinition-ImmunizationRecommendation.xml"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "special-url-base"
},
"value": "http://hl7.org/fhir"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-history"
},
"value": "http://hl7.org/fhir/uv/immunization-incubator/history.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "autoload-resources"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/capabilities"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/examples"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/extensions"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/models"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/operations"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/profiles"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/vocabulary"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/testing"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/history"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "fsh-generated/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "template/config"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "input/assets"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "input/images"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "template/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "input/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-qa"
},
"value": "temp/qa"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-temp"
},
"value": "temp/pages"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-output"
},
"value": "output"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-tx-cache"
},
"value": "input-cache/txcache"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-suppressed-warnings"
},
"value": "input/ignoreWarnings.txt"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-html"
},
"value": "template-page.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-md"
},
"value": "template-page-md.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-contact"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-context"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-copyright"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-jurisdiction"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-license"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-publisher"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-version"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-wg"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "active-tables"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "fmm-definition"
},
"value": "http://hl7.org/fhir/versions.html#maturity"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "propagate-status"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "excludelogbinaryformat"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "tabbed-snapshots"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "i18n-default-lang"
},
"value": "en"
}
]
}
}