Immunization

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. If the element is present, it must have either a @value, an @id, or extensions

type Immunization implements Resource {
  identifier: [Identifier]
  status: String
  statusReason: CodeableConcept
  vaccineCode: CodeableConcept
  patient: Reference
  encounter: Reference
  occurrenceDateTime: Date
  occurrenceString: String
  recorded: Date
  primarySource: Boolean
  reportOrigin: CodeableConcept
  location: Reference
  manufacturer: Reference
  lotNumber: String
  expirationDate: Date
  site: CodeableConcept
  route: CodeableConcept
  doseQuantity: Quantity
  performer: [ImmunizationPerformer]
  note: [Annotation]
  reasonCode: [CodeableConcept]
  reasonReference: [Reference]
  isSubpotent: Boolean
  subpotentReason: [CodeableConcept]
  education: [ImmunizationEducation]
  programEligibility: [CodeableConcept]
  fundingSource: CodeableConcept
  reaction: [ImmunizationReaction]
  protocolApplied: [ImmunizationProtocolApplied]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

Immunization.identifier ● [Identifier] list object

A unique identifier assigned to this immunization record.

Immunization.status ● String scalar

Indicates the current status of the immunization event.

Immunization.statusReason ● CodeableConcept object

Indicates the reason the immunization event was not performed.

Immunization.vaccineCode ● CodeableConcept object

Vaccine that was administered or was to be administered.

Immunization.patient ● Reference object

The patient who either received or did not receive the immunization.

Immunization.encounter ● Reference object

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Immunization.occurrenceDateTime ● Date scalar

Date vaccine administered or was to be administered. (choose any one of occurrence*, but only one)

Immunization.occurrenceString ● String scalar

Date vaccine administered or was to be administered. (choose any one of occurrence*, but only one)

Immunization.recorded ● Date scalar

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Immunization.primarySource ● Boolean scalar

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Immunization.reportOrigin ● CodeableConcept object

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Immunization.location ● Reference object

The service delivery location where the vaccine administration occurred.

Immunization.manufacturer ● Reference object

Name of vaccine manufacturer.

Immunization.lotNumber ● String scalar

Lot number of the vaccine product.

Immunization.expirationDate ● Date scalar

Date vaccine batch expires.

Immunization.site ● CodeableConcept object

Body site where vaccine was administered.

Immunization.route ● CodeableConcept object

The path by which the vaccine product is taken into the body.

Immunization.doseQuantity ● Quantity object

The quantity of vaccine product that was administered.

Immunization.performer ● [ImmunizationPerformer] list object

Indicates who performed the immunization event.

Immunization.note ● [Annotation] list object

Extra information about the immunization that is not conveyed by the other attributes.

Immunization.reasonCode ● [CodeableConcept] list object

Reasons why the vaccine was administered.

Immunization.reasonReference ● [Reference] list object

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Immunization.isSubpotent ● Boolean scalar

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Immunization.subpotentReason ● [CodeableConcept] list object

Reason why a dose is considered to be subpotent.

Immunization.education ● [ImmunizationEducation] list object

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Immunization.programEligibility ● [CodeableConcept] list object

Indicates a patient s eligibility for a funding program.

Immunization.fundingSource ● CodeableConcept object

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

Immunization.reaction ● [ImmunizationReaction] list object

Categorical data indicating that an adverse event is associated in time to an immunization.

Immunization.protocolApplied ● [ImmunizationProtocolApplied] list object

The protocol (set of recommendations) being followed by the provider who administered the dose.

Immunization.text ● Narrative object

A 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.

Immunization.contained ● [Resource] list interface

These 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.

Immunization.extension ● [Extension] list object

May 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.

Immunization.modifierExtension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Immunization.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Immunization.meta ● Meta object

The 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.

Immunization.implicitRules ● Uri scalar

A 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.

Immunization.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

Immunization query ● ImmunizationCreate mutation ● ImmunizationList query ● ImmunizationUpdate mutation