Defines constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve patient's immunization information.
Subclass of hl7.model.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.)
- Value Params
- 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.
- doseQuantity
- The quantity of vaccine product that was administered.
- education
- Educational material presented to the patient (or guardian) at the time of vaccine administration.
- encounter
- The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
- expirationDate
- Date vaccine batch expires.
- 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.
- 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).
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A unique identifier assigned to this immunization record.
- 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.
- isSubpotent
- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- language
- The base language in which the resource is written.
- location
- The service delivery location where the vaccine administration occurred.
- lotNumber
- Lot number of the vaccine product.
- manufacturer
- Name of vaccine manufacturer.
- 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.
- 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).
- note
- Extra information about the immunization that is not conveyed by the other attributes.
- occurrence
- Date vaccine administered or was to be administered.
- patient
- The patient who either received or did not receive the immunization.
- performer
- Indicates who performed the immunization event.
- 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.
- programEligibility
- Indicates a patient's eligibility for a funding program.
- protocolApplied
- The protocol (set of recommendations) being followed by the provider who administered the dose.
- reaction
- Categorical data indicating that an adverse event is associated in time to an immunization.
- reasonCode
- Reasons why the vaccine was administered.
- reasonReference
- Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- recorded
- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
- 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.
- route
- The path by which the vaccine product is taken into the body.
- site
- Body site where vaccine was administered.
- status
- Indicates the current status of the immunization event.
- statusReason
- Indicates the reason the immunization event was not performed.
- subpotentReason
- Reason why a dose is considered to be subpotent.
- 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.
- vaccineCode
- Vaccine that was administered or was to be administered.
- Constructor
Inherits all params from parent. Requires the following fields which were optional in the parent: primarySource.
- Companion
- object
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
T
should not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET }
)
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from
- FHIRObject
- Inherited from
- Utils
- Inherited from
- Utils
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from
- FHIRObject
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
T
should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject