Immunization class

Immunization Describes the event of a patient being administered a

Mixed in types

• Resource

Annotations

• @freezed

Constructors

Immunization({@Default(R4ResourceType.Immunization) @JsonKey(unknownEnumValue: R4ResourceType.Immunization) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? statusReason, required CodeableConcept vaccineCode, required Reference patient, Reference? encounter, FhirDateTime? occurrenceDateTime, @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement, String? occurrenceString, @JsonKey(name: '_occurrenceString') Element? occurrenceStringElement, FhirDateTime? recorded, @JsonKey(name: '_recorded') Element? recordedElement, FhirBoolean? primarySource, @JsonKey(name: '_primarySource') Element? primarySourceElement, CodeableConcept? reportOrigin, Reference? location, Reference? manufacturer, String? lotNumber, @JsonKey(name: '_lotNumber') Element? lotNumberElement, FhirDate? expirationDate, @JsonKey(name: '_expirationDate') Element? expirationDateElement, CodeableConcept? site, CodeableConcept? route, Quantity? doseQuantity, List<ImmunizationPerformer>? performer, List<Annotation>? note, List<CodeableConcept>? reasonCode, List<Reference>? reasonReference, FhirBoolean? isSubpotent, @JsonKey(name: '_isSubpotent') Element? isSubpotentElement, List<CodeableConcept>? subpotentReason, List<ImmunizationEducation>? education, List<CodeableConcept>? programEligibility, CodeableConcept? fundingSource, List<ImmunizationReaction>? reaction, List<ImmunizationProtocolApplied>? protocolApplied})

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.

const

factory

Immunization.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

Immunization.fromJsonString(String source)

Acts like a constructor, returns a Immunization, accepts a String as an argument, mostly because I got tired of typing it out

factory

Immunization.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

contained → List<Resource>?

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

no setter, inherited

copyWith → $ImmunizationCopyWith<Immunization>

no setter, inherited

dbId → int?

no setter, inherited

doseQuantity → Quantity?

doseQuantity The quantity of vaccine product that was administered.

no setter, inherited

education → List<ImmunizationEducation>?

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

no setter, inherited

encounter → Reference?

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

no setter, inherited

expirationDate → FhirDate?

expirationDate Date vaccine batch expires.

no setter, inherited

expirationDateElement → Element?

expirationDateElement Extensions for expirationDate

no setter, inherited

extension_ → List<FhirExtension>?

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

no setter, inherited

fhirId → String?

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

no setter, inherited

fundingSource → CodeableConcept?

fundingSource 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).

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier A unique identifier assigned to this immunization record.

no setter, inherited

implicitRules → FhirUri?

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

no setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

isSubpotent → FhirBoolean?

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

no setter, inherited

isSubpotentElement → Element?

isSubpotentElement Extensions for isSubpotent

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

location → Reference?

location The service delivery location where the vaccine administration occurred.

no setter, inherited

lotNumber → String?

lotNumber Lot number of the vaccine product.

no setter, inherited

lotNumberElement → Element?

lotNumberElement Extensions for lotNumber

no setter, inherited

manufacturer → Reference?

manufacturer Name of vaccine manufacturer.

no setter, inherited

meta → FhirMeta?

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

no setter, inherited

modifierExtension → List<FhirExtension>?

modifierExtension 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).

no setter, inherited

note → List<Annotation>?

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

no setter, inherited

occurrenceDateTime → FhirDateTime?

occurrenceDateTime Date vaccine administered or was to be administered.

no setter, inherited

occurrenceDateTimeElement → Element?

occurrenceDateTimeElement Extensions for occurrenceDateTime

no setter, inherited

occurrenceString → String?

occurrenceString Date vaccine administered or was to be administered.

no setter, inherited

occurrenceStringElement → Element?

occurrenceStringElement Extensions for occurrenceString

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

patient → Reference

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

no setter, inherited

performer → List<ImmunizationPerformer>?

performer Indicates who performed the immunization event.

no setter, inherited

primarySource → FhirBoolean?

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

no setter, inherited

primarySourceElement → Element?

primarySourceElement Extensions for primarySource

no setter, inherited

programEligibility → List<CodeableConcept>?

programEligibility Indicates a patient's eligibility for a funding program.

no setter, inherited

protocolApplied → List<ImmunizationProtocolApplied>?

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

no setter, inherited

reaction → List<ImmunizationReaction>?

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

no setter, inherited

reasonCode → List<CodeableConcept>?

reasonCode Reasons why the vaccine was administered.

no setter, inherited

reasonReference → List<Reference>?

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

no setter, inherited

recorded → FhirDateTime?

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

no setter, inherited

recordedElement → Element?

recordedElement Extensions for recorded

no setter, inherited

reportOrigin → CodeableConcept?

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

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

route → CodeableConcept?

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

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

site → CodeableConcept?

site Body site where vaccine was administered.

no setter, inherited

status → FhirCode?

status Indicates the current status of the immunization event.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

statusReason → CodeableConcept?

statusReason Indicates the reason the immunization event was not performed.

no setter, inherited

subpotentReason → List<CodeableConcept>?

subpotentReason Reason why a dose is considered to be subpotent.

no setter, inherited

text → Narrative?

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

no setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

vaccineCode → CodeableConcept

vaccineCode Vaccine that was administered or was to be administered.

no setter, inherited

Methods

newId() → Resource

returns the same resource with a new ID (even if there is already an ID present)

inherited

newIdIfNoId() → Resource

returns the same resource with a new ID if there is no current ID

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDbJson() → Map<String, dynamic>

The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids

inherited

toJson() → Map<String, dynamic>

inherited

toJsonString() → String

Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map

override

toString() → String

A string representation of this object.

inherited

toYaml() → String

Produces a Yaml formatted String version of the object

inherited

updateVersion({FhirMeta? oldMeta}) → Resource

Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited