ImmunizationEvaluation

ResourceClinical · MedicationsTrial useMaturity 0

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

7 of 7 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifier	0..*	Identifier	Business identifier
statusRequired?!Σ	1..1	code	completed | entered-in-errorBinding (required): immunization-evaluation-status
patientRequiredΣ	1..1	Reference(Patient)	Who this evaluation is for
date	0..1	dateTime	Date evaluation was performed
authority	0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDiseaseRequiredΣ	1..1	CodeableConcept	Evaluation target diseaseBinding (example): immunization-evaluation-target-disease
immunizationEventRequiredΣ	1..1	Reference(Immunization)	Immunization being evaluated
doseStatusRequiredΣ	1..1	CodeableConcept	Status of the dose relative to published recommendationsBinding (example): immunization-evaluation-dose-status
doseStatusReason	0..*	CodeableConcept	Reason for the dose statusBinding (example): immunization-evaluation-dose-status-reason
description	0..1	string	Evaluation notes
series	0..1	string	Name of vaccine series
doseNumber[x]	0..1	positiveInt | string	Dose number within series
seriesDoses[x]	0..1	positiveInt | string	Recommended number of doses for immunity

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ImmunizationEvaluation?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
date	date	Date the evaluation was generated ImmunizationEvaluation.date
dose-status	token	The status of the dose relative to published recommendations ImmunizationEvaluation.doseStatus
identifier	token	ID of the evaluation ImmunizationEvaluation.identifier
immunization-event	reference	The vaccine administration event being evaluated ImmunizationEvaluation.immunizationEvent
patient	reference	The patient being evaluated ImmunizationEvaluation.patient
status	token	Immunization evaluation status ImmunizationEvaluation.status
target-disease	token	The vaccine preventable disease being evaluated against ImmunizationEvaluation.targetDisease

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition