spark_auto_mapper_fhir.resources.immunization_evaluation

Module Contents

Classes

ImmunizationEvaluation

ImmunizationEvaluation
class spark_auto_mapper_fhir.resources.immunization_evaluation.ImmunizationEvaluation(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, status, patient, date=None, authority=None, targetDisease, immunizationEvent, doseStatus, doseStatusReason=None, description=None, series=None, doseNumberPositiveInt=None, doseNumberString=None, seriesDosesPositiveInt=None, seriesDosesString=None)

Bases: spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase

ImmunizationEvaluation immunizationevaluation.xsd

Describes a comparison of an immunization event against published

recommendations to determine if the administration is “valid” in relation to those recommendations.

If the element is present, it must have either a @value, an @id, or extensions

Describes a comparison of an immunization event against published

recommendations to determine if the administration is “valid” in relation to those recommendations.

If the element is present, it must have either a @value, an @id, or extensions

param id_

The logical id of the resource, as used in the URL for the resource. Once

assigned, this value never changes.
param 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.

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

param language

The base language in which the resource is written.

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

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

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

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

param identifier

A unique identifier assigned to this immunization evaluation record.

param status

Indicates the current status of the evaluation of the vaccination

administration event.
param patient

The individual for whom the evaluation is being done.

param date

The date the evaluation of the vaccine administration event was performed.

param authority

Indicates the authority who published the protocol (e.g. ACIP).

param targetDisease

The vaccine preventable disease the dose is being evaluated against.

param immunizationEvent

The vaccine administration event being evaluated.

param doseStatus

Indicates if the dose is valid or not valid with respect to the published

recommendations.
param doseStatusReason

Provides an explanation as to why the vaccine administration event is valid or

not relative to the published recommendations.
param description

Additional information about the evaluation.

param series

One possible path to achieve presumed immunity against a disease - within the

context of an authority.
param doseNumberPositiveInt

None

param doseNumberString

None

param seriesDosesPositiveInt

None

param seriesDosesString

None

Parameters
get_schema(self, include_extension)
Parameters

include_extension (bool) –

Return type

Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]