Immunization class
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.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Immunization({@Default(R5ResourceType.Immunization) @JsonKey(unknownEnumValue: R5ResourceType.Immunization) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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, List<Reference> ? basedOn, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? statusReason, required CodeableConcept vaccineCode, CodeableReference? administeredProduct, CodeableReference? manufacturer, String? lotNumber, @JsonKey(name: '_lotNumber') Element? lotNumberElement, FhirDate? expirationDate, @JsonKey(name: '_expirationDate') Element? expirationDateElement, required Reference patient, Reference? encounter, List<Reference> ? supportingInformation, FhirDateTime? occurrenceDateTime, @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement, String? occurrenceString, @JsonKey(name: '_occurrenceString') Element? occurrenceStringElement, FhirBoolean? primarySource, @JsonKey(name: '_primarySource') Element? primarySourceElement, CodeableReference? informationSource, Reference? location, CodeableConcept? site, CodeableConcept? route, Quantity? doseQuantity, List<ImmunizationPerformer> ? performer, List<Annotation> ? note, List<CodeableReference> ? reason, FhirBoolean? isSubpotent, @JsonKey(name: '_isSubpotent') Element? isSubpotentElement, List<CodeableConcept> ? subpotentReason, List<ImmunizationProgramEligibility> ? 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.
constfactory
-
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
- administeredProduct → CodeableReference?
-
administeredProduct An indication of which product was administered
to the patient. This is typically a more detailed representation of
the concept conveyed by the vaccineCode data element. If a Medication
resource is referenced, it may be to a stand-alone resource or a
contained resource within the Immunization resource.
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn A plan, order or recommendation fulfilled in whole or in part
by this immunization.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $ImmunizationCopyWith<
Immunization> -
no setterinherited
- dbId → int?
-
no setterinherited
- doseQuantity → Quantity?
-
doseQuantity The quantity of vaccine product that was administered.
no setterinherited
- encounter → Reference?
-
encounter The visit or admission or other contact between patient and
health care provider the immunization was performed as part of.
no setterinherited
- expirationDate → FhirDate?
-
expirationDate Date vaccine batch expires.
no setterinherited
- expirationDateElement → Element?
-
expirationDateElement ("_expirationDate") Extensions for
expirationDate
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("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 managable, 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 setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- 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 setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier A unique identifier assigned to this immunization record.
no setterinherited
- 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 setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- informationSource → CodeableReference?
-
informationSource Typically 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 setterinherited
- isSubpotent → FhirBoolean?
-
isSubpotent Indication if a dose is considered to be subpotent. By
default, a dose should be considered to be potent.
no setterinherited
- isSubpotentElement → Element?
-
isSubpotentElement ("_isSubpotent") Extensions for isSubpotent
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- location → Reference?
-
location The service delivery location where the vaccine
administration occurred.
no setterinherited
- lotNumber → String?
-
lotNumber Lot number of the vaccine product.
no setterinherited
- lotNumberElement → Element?
-
lotNumberElement ("_lotNumber") Extensions for lotNumber
no setterinherited
- manufacturer → CodeableReference?
-
manufacturer Name of vaccine manufacturer.
no setterinherited
- 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 setterinherited
-
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 managable, 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 setterinherited
-
note
→ List<
Annotation> ? -
note Extra information about the immunization that is not conveyed by
the other attributes.
no setterinherited
- occurrenceDateTime → FhirDateTime?
-
occurrenceDateTime Date vaccine administered or was to be
administered.
no setterinherited
- occurrenceDateTimeElement → Element?
-
occurrenceDateTimeElement ("_occurrenceDateTime") Extensions for
occurrenceDateTime
no setterinherited
- occurrenceString → String?
-
occurrenceString Date vaccine administered or was to be administered.
no setterinherited
- occurrenceStringElement → Element?
-
occurrenceStringElement ("_occurrenceString") Extensions for
occurrenceString
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- patient → Reference
-
patient The patient who either received or did not receive the
immunization.
no setterinherited
-
performer
→ List<
ImmunizationPerformer> ? -
performer Indicates who performed the immunization event.
no setterinherited
- primarySource → FhirBoolean?
-
primarySource Indicates whether the data contained in the resource
was captured by the individual/organization which was responsible for
the administration of the vaccine rather than as 'secondary reported'
data documented by a third party. A value of 'true' means this data
originated with the individual/organization which was responsible for
the administration of the vaccine.
no setterinherited
- primarySourceElement → Element?
-
primarySourceElement ("_primarySource") Extensions for primarySource
no setterinherited
-
programEligibility
→ List<
ImmunizationProgramEligibility> ? -
programEligibility Indicates a patient's eligibility for a funding
program.
no setterinherited
-
protocolApplied
→ List<
ImmunizationProtocolApplied> ? -
protocolApplied The protocol (set of recommendations) being followed
by the provider who administered the dose.
no setterinherited
-
reaction
→ List<
ImmunizationReaction> ? -
reaction Categorical data indicating that an adverse event is
associated in time to an immunization.
no setterinherited
-
reason
→ List<
CodeableReference> ? -
reason Describes why the immunization occurred in coded or textual
form, or Indicates another resource (Condition, Observation or
DiagnosticReport) whose existence justifies this immunization.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Immunization resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- route → CodeableConcept?
-
route The path by which the vaccine product is taken into the body.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- site → CodeableConcept?
-
site Body site where vaccine was administered.
no setterinherited
- status → FhirCode?
-
status Indicates the current status of the immunization event.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- statusReason → CodeableConcept?
-
statusReason Indicates the reason the immunization event was not
performed.
no setterinherited
-
subpotentReason
→ List<
CodeableConcept> ? -
subpotentReason Reason why a dose is considered to be subpotent.
no setterinherited
-
supportingInformation
→ List<
Reference> ? -
supportingInformation Additional information that is relevant to the
immunization (e.g. for a vaccine recipient who is pregnant, the
gestational age of the fetus). The reason why a vaccine was given
(e.g. occupation, underlying medical condition) should be conveyed in
Immunization.reason, not as supporting information. The reason why a
vaccine was not given (e.g. contraindication) should be conveyed in
Immunization.statusReason, not as supporting information.
no setterinherited
- 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 setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- vaccineCode → CodeableConcept
-
vaccineCode Vaccine that was administered or was to be administered.
no setterinherited
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
override
-
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