Others titles

  • FHIR Immunization Evaluation Resource
  • Electronic Health Records Exchange Through FHIR


  • FHIR
  • HL7
  • Medical Terminology
  • Processes Data
  • Processes Information
  • Processes Documentation
  • Health Information Exchange
  • Electronic Health Records
  • FHIR Smart
  • Smart on FHIR

Immunization Evaluation

The Immunization Evaluation resource intends to cover communicating the results of an evaluation of a vaccine administration event against a set of published recommendations (protocols). Evaluating administered doses in a patient’s immunization history is central to ensuring that the patient is fully protected against vaccine-preventable diseases. It is also a necessary prerequisite to generating a customized set of immunization recommendations for the patient.

Log in to download

Get The Data

  • The data in CSV format DOWNLOAD
  • Metadata in Human Readable format (PDF) DOWNLOAD
  • Metadata in Machine Readable format (JSON) DOWNLOAD
Your Data License
  • Research
    Non-Commercial, Share-Alike, Attribution Free Forever
  • Commercial
    Commercial Use, Remix & Adapt, White Label Buy Subscription


The Immunization Evaluation resource communicates the results of an evaluation of an instance of the Immunization resource relative to a set of published recommendations. It is intended to communicate if the vaccine administration event was “valid” or “not valid” relative to the recommendations. Once all vaccine administration events in a patient’s record have been evaluated, it is then possible to generate a set of vaccination related recommendations, unique for the patient. These recommendations are communicated using the Immunization Recommendation resource.

As the Immunization Evaluation resource is focused on the evaluation of a single vaccine administration event, it does not include data regarding the overall patient status relative to the recommendations used in the evaluation. For example, a total of 3 doses of hepatitis B vaccine may be required for patient protection, but an instance of the Immunization Evaluation resource will be concerned with only one of the doses (although other instances of Immunization Evaluation should exist for the other doses). The Immunization Recommendation resource is used to convey the overall patient status (eg. a dose is due or the patient is complete) relative to the hepatitis B series.

About this Dataset

Data Info

Date Created


Last Modified




Update Frequency


Temporal Coverage


Spatial Coverage

United States


John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements


Source Citation



FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Immunization Evaluation Resource, Electronic Health Records Exchange Through FHIR

Data Fields

Name Description Type Constraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-

Data Preview

Concept NameComputer Ready NameTypeDollar RefDescriptionItemsRequiredConst
ImmunizationEvaluationresourceTypeThis is a ImmunizationEvaluation resourceImmunizationEvaluation
ImmunizationEvaluationid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
ImmunizationEvaluationmeta#/definitions/MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ImmunizationEvaluationimplicitRules#/definitions/uriA reference to a set of rules that were followed when the resource was constructed and which must be understood when processing the content. Often this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ImmunizationEvaluation_implicitRules#/definitions/ElementExtensions for implicitRules
ImmunizationEvaluationlanguage#/definitions/codeThe base language in which the resource is written.
ImmunizationEvaluation_language#/definitions/ElementExtensions for language
ImmunizationEvaluationtext#/definitions/NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ImmunizationEvaluationcontainedarrayThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently and nor can they have their own independent transaction scope.{'$ref': '#/definitions/ResourceList'}
ImmunizationEvaluationextensionarrayMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension there is a set of requirements that SHALL be met as part of the definition of the extension.{'$ref': '#/definitions/Extension'}