extension shown: fhir [x]


Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/Immunization

Thing > Resource > DomainResource > Immunization
clinical.medication > Immunization

Base StructureDefinition for Immunization Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from Immunization
Immunization.date DateTime Date vaccine administered or was to be administered.
Immunization.doseQuantity Quantity The quantity of vaccine product that was administered.
Immunization.encounter Encounter The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Immunization.expirationDate Date Date vaccine batch expires.
Immunization.explanation BackboneElement Reasons why a vaccine was or was not administered.
Immunization.explanation.reason immunization-reason Reasons why a vaccine was administered.
Immunization.explanation.reasonNotGiven no-immunization-reason Reason why a vaccine was not administered.
Immunization.identifier Identifier A unique identifier assigned to this immunization record.
Immunization.location Location The service delivery location where the vaccine administration occurred.
Immunization.lotNumber Text Lot number of the vaccine product.
Immunization.manufacturer Organization Name of vaccine manufacturer.
Immunization.note Annotation Extra information about the immunization that is not conveyed by the other attributes.
Immunization.patient Patient The patient who either received or did not receive the immunization.
Immunization.performer Practitioner Clinician who administered the vaccine.
Immunization.reaction BackboneElement Categorical data indicating that an adverse event is associated in time to an immunization.
Immunization.reaction.date DateTime Date of reaction to the immunization.
Immunization.reaction.detail Observation Details of the reaction.
Immunization.reaction.reported Boolean Self-reported indicator.
Immunization.reported Boolean True if this administration was reported rather than directly administered.
Immunization.requester Practitioner Clinician who ordered the vaccination.
Immunization.route immunization-route The path by which the vaccine product is taken into the body.
Immunization.site immunization-site Body site where vaccine was administered.
Immunization.status medication-admin-status Indicates the current status of the vaccination event.
Immunization.vaccinationProtocol BackboneElement Contains information about the protocol(s) under which the vaccine was administered.
Immunization.vaccinationProtocol.authority Organization Indicates the authority who published the protocol. E.g. ACIP.
Immunization.vaccinationProtocol.description Text Contains the description about the protocol under which the vaccine was administered.
Immunization.vaccinationProtocol.doseSequence positiveInt Nominal position in a series.
Immunization.vaccinationProtocol.doseStatus vaccination-protocol-dose-status Indicates if the immunization event should "count" against the protocol.
Immunization.vaccinationProtocol.doseStatusReason vaccination-protocol-dose-status-reason Provides an explanation as to why an immunization event should or should not count against the protocol.
Immunization.vaccinationProtocol.series Text One possible path to achieve presumed immunity against a disease - within the context of an authority.
Immunization.vaccinationProtocol.seriesDoses positiveInt The recommended number of doses to achieve immunity.
Immunization.vaccinationProtocol.targetDisease vaccination-protocol-dose-target The targeted disease.
Immunization.vaccineCode vaccine-code Vaccine that was administered or was to be administered.
Immunization.wasNotGiven Boolean Indicates if the vaccination was or was not given.
Properties from DomainResource
DomainResource.contained Resource 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.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
DomainResource.modifierExtension Extension 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. Usually modifier elements provide negation or qualification. In order 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.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may 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.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image URL  or
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Instances of Immunization may appear as values for the following properties
PropertyOn TypesDescription
ImmunizationRecommendation.recommendation.supportingImmunization ImmunizationRecommendation Immunization event history that supports the status and recommendation.

Available supertypes defined in extensions

Schema Version 2.2