Show / Hide Table of Contents

Class Immunization

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Inheritance
System.Object
Resource
DomainResource
Immunization
Implements
IFhirJsonSerializable
Inherited Members
DomainResource.Contained
DomainResource.Extension
DomainResource.ModifierExtension
DomainResource.Text
Resource.Id
Resource._Id
Resource.ImplicitRules
Resource._ImplicitRules
Resource.Language
Resource._Language
Resource.Meta
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class Immunization : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Date

Extension container element for Date

Declaration
public Element _Date { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_ExpirationDate

Extension container element for ExpirationDate

Declaration
public Element _ExpirationDate { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_LotNumber

Extension container element for LotNumber

Declaration
public Element _LotNumber { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Reported

Extension container element for Reported

Declaration
public Element _Reported { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_WasNotGiven

Extension container element for WasNotGiven

Declaration
public Element _WasNotGiven { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

Date

Date vaccine administered or was to be administered.

Declaration
public string Date { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DoseQuantity

The quantity of vaccine product that was administered.

Declaration
public Quantity DoseQuantity { get; set; }
Property Value
Type Description
Quantity
| Improve this Doc View Source

Encounter

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

Declaration
public Reference Encounter { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

ExpirationDate

Date vaccine batch expires.

Declaration
public string ExpirationDate { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Explanation

Reasons why a vaccine was or was not administered.

Declaration
public ImmunizationExplanation Explanation { get; set; }
Property Value
Type Description
ImmunizationExplanation
| Improve this Doc View Source

Identifier

A unique identifier assigned to this immunization record.

Declaration
public List<Identifier> Identifier { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Identifier>
| Improve this Doc View Source

Location

The service delivery location where the vaccine administration occurred.

Declaration
public Reference Location { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

LotNumber

Lot number of the vaccine product.

Declaration
public string LotNumber { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Manufacturer

Name of vaccine manufacturer.

Declaration
public Reference Manufacturer { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Note

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

Declaration
public List<Annotation> Note { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Annotation>
| Improve this Doc View Source

Patient

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

Declaration
public Reference Patient { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Performer

Clinician who administered the vaccine.

Declaration
public Reference Performer { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Reaction

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

Declaration
public List<ImmunizationReaction> Reaction { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<ImmunizationReaction>
| Improve this Doc View Source

Reported

True if this administration was reported rather than directly administered.

Declaration
public bool Reported { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Requester

Clinician who ordered the vaccination.

Declaration
public Reference Requester { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

ResourceType

Resource Type Name

Declaration
public override string ResourceType { get; }
Property Value
Type Description
System.String
Overrides
Resource.ResourceType
| Improve this Doc View Source

Route

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

Declaration
public CodeableConcept Route { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

Site

Body site where vaccine was administered.

Declaration
public CodeableConcept Site { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

Status

Indicates the current status of the vaccination event.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

VaccinationProtocol

Contains information about the protocol(s) under which the vaccine was administered.

Declaration
public List<ImmunizationVaccinationProtocol> VaccinationProtocol { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<ImmunizationVaccinationProtocol>
| Improve this Doc View Source

VaccineCode

Vaccine that was administered or was to be administered.

Declaration
public CodeableConcept VaccineCode { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

WasNotGiven

Indicates if the vaccination was or was not given.

Declaration
public bool WasNotGiven { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)

Deserialize a JSON property

Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
System.String propertyName
| Improve this Doc View Source

SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)

Serialize to a JSON object

Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
Type Name Description
Utf8JsonWriter writer
JsonSerializerOptions options
System.Boolean includeStartObject

Implements

IFhirJsonSerializable
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX