ImmunizationEvaluation

Trial Use 1 Clinical — Medications

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/ImmunizationEvaluation

Interaction	Method	Path
Read	GET	/fhir/R5/ImmunizationEvaluation/[id]
Vread	GET	/fhir/R5/ImmunizationEvaluation/[id]/_history/[vid]
Update	PUT	/fhir/R5/ImmunizationEvaluation/[id]
Patch	PATCH	/fhir/R5/ImmunizationEvaluation/[id]
Delete	DELETE	/fhir/R5/ImmunizationEvaluation/[id]
Create	POST	/fhir/R5/ImmunizationEvaluation
Search	GET	/fhir/R5/ImmunizationEvaluation?...
History	GET	/fhir/R5/ImmunizationEvaluation/[id]/_history
Type-history	GET	/fhir/R5/ImmunizationEvaluation/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Business identifier
status	code	1..1	completed
patient	Reference	1..1	Who this evaluation is for
date	dateTime	0..1	Date evaluation was performed
authority	Reference	0..1	Who is responsible for publishing the recommendations
targetDisease	CodeableConcept	1..1	The vaccine preventable disease schedule being evaluated
immunizationEvent	Reference	1..1	Immunization being evaluated
doseStatus	CodeableConcept	1..1	Status of the dose relative to published recommendations
doseStatusReason	CodeableConcept	0..*	Reason why the doese is considered valid, invalid or some other status
description	markdown	0..1	Evaluation notes
series	string	0..1	Name of vaccine series
doseNumber	string	0..1	Dose number within series
seriesDoses	string	0..1	Recommended number of doses for immunity

Resource-specific search parameters

Parameter	Type	Description
date	date	When the event occurred
dose-status	token	The status of the dose relative to published recommendations
identifier	token	Account number
immunization-event	reference	The vaccine administration event being evaluated
patient	reference	The entity that caused the expenses
status	token	Immunization evaluation status
target-disease	token	The vaccine preventable disease being evaluated against

Reference

• Official FHIR R5 spec: ImmunizationEvaluation
• Maturity: Trial Use 1 (FMM 1).