Immunization

ResourceClinical · MedicationsTrial useMaturity 3

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

16 of 16 parameters tested

Structure

Show inherited elements (20)

Element	Card.	Type	Description
identifier	0..*	Identifier	Business identifier
statusRequired?!Σ	1..1	code	completed | entered-in-error | not-doneBinding (required): immunization-status
statusReason	0..1	CodeableConcept	Reason not doneBinding (example): immunization-status-reason
vaccineCodeRequiredΣ	1..1	CodeableConcept	Vaccine product administeredBinding (example): vaccine-code
patientRequiredΣ	1..1	Reference(Patient)	Who was immunized
encounter	0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]RequiredΣ	1..1	dateTime | string	Vaccine administration date
recorded	0..1	dateTime	When the immunization was first captured in the subject's record
primarySourceΣ	0..1	boolean	Indicates context the data was recorded in
reportOrigin	0..1	CodeableConcept	Indicates the source of a secondarily reported recordBinding (example): immunization-origin
location	0..1	Reference(Location)	Where immunization occurred
manufacturer	0..1	Reference(Organization)	Vaccine manufacturer
lotNumber	0..1	string	Vaccine lot number
expirationDate	0..1	date	Vaccine expiration date
site	0..1	CodeableConcept	Body site vaccine was administeredBinding (example): immunization-site
route	0..1	CodeableConcept	How vaccine entered bodyBinding (example): immunization-route
doseQuantity	0..1	Quantity	Amount of vaccine administered
performerΣ	0..*	BackboneElement	Who performed event
functionΣ	0..1	CodeableConcept	What type of performance was doneBinding (extensible): immunization-function
actorRequiredΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
noteΣ	0..*	Annotation	Additional immunization notes
reasonCode	0..*	CodeableConcept	Why immunization occurredBinding (example): immunization-reason
reasonReference	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent?!Σ	0..1	boolean	Dose potency
subpotentReason	0..*	CodeableConcept	Reason for being subpotentBinding (example): immunization-subpotent-reason
education	0..*	BackboneElement	Educational material presented to patient
documentType	0..1	string	Educational material document identifier
reference	0..1	uri	Educational material reference pointer
publicationDate	0..1	dateTime	Educational material publication date
presentationDate	0..1	dateTime	Educational material presentation date
programEligibility	0..*	CodeableConcept	Patient eligibility for a vaccination programBinding (example): immunization-program-eligibility
fundingSource	0..1	CodeableConcept	Funding source for the vaccineBinding (example): immunization-funding-source
reaction	0..*	BackboneElement	Details of a reaction that follows immunization
date	0..1	dateTime	When reaction started
detail	0..1	Reference(Observation)	Additional information on reaction
reported	0..1	boolean	Indicates self-reported reaction
protocolApplied	0..*	BackboneElement	Protocol followed by the provider
series	0..1	string	Name of vaccine series
authority	0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	0..*	CodeableConcept	Vaccine preventatable disease being targettedBinding (example): immunization-target-disease
doseNumber[x]Required	1..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]/Immunization?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
date	date	Vaccination (non)-Administration Date Immunization.occurrence
identifier	token	Business identifier Immunization.identifier
location	reference	The service delivery location or facility in which the vaccine was / was to be administered Immunization.location
lot-number	string	Vaccine Lot Number Immunization.lotNumber
manufacturer	reference	Vaccine Manufacturer Immunization.manufacturer
patient	reference	The patient for the vaccination record Immunization.patient
performer	reference	The practitioner or organization who played a role in the vaccination Immunization.performer.actor
reaction	reference	Additional information on reaction Immunization.reaction.detail
reaction-date	date	When reaction started Immunization.reaction.date
reason-code	token	Reason why the vaccine was administered Immunization.reasonCode
reason-reference	reference	Why immunization occurred Immunization.reasonReference
series	string	The series being followed by the provider Immunization.protocolApplied.series
status	token	Immunization event status Immunization.status
status-reason	token	Reason why the vaccine was not administered Immunization.statusReason
target-disease	token	The target disease the dose is being administered against Immunization.protocolApplied.targetDisease
vaccine-code	token	Vaccine Product Administered Immunization.vaccineCode

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