Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TImmunization

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TImmunization = class(TDomainResource)

Description

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. If the element is present, it must have either a @value, an @id, or extensions

Hierarchy

Overview

Methods

Public constructor Create; override;

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;
Public property basedOn : TReferenceArray read GetbasedOnArray;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TImmunizationStatusCodes read GetstatusElement write SetstatusElement;
Public property statusReason : TCodeableConcept read GetstatusReason write SetstatusReason;
Public property vaccineCode : TCodeableConcept read GetvaccineCode write SetvaccineCode;
Public property administeredProduct : TCodeableReference read GetadministeredProduct write SetadministeredProduct;
Public property manufacturer : TCodeableReference read Getmanufacturer write Setmanufacturer;
Public property lotNumber : string read GetlotNumber write SetlotNumber;
Public property lotNumberElement : Tstring read GetlotNumberElement write SetlotNumberElement;
Public property expirationDate : string read GetexpirationDate write SetexpirationDate;
Public property expirationDateElement : Tdate_ read GetexpirationDateElement write SetexpirationDateElement;
Public property patient : TReference read Getpatient write Setpatient;
Public property encounter : TReference read Getencounter write Setencounter;
Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;
Public property occurrenceDateTime : string read GetoccurrenceDateTime write SetoccurrenceDateTime;
Public property occurrenceDateTimeElement : TdateTime_ read GetoccurrenceDateTimeElement write SetoccurrenceDateTimeElement;
Public property occurrenceString : string read GetoccurrenceString write SetoccurrenceString;
Public property occurrenceStringElement : Tstring read GetoccurrenceStringElement write SetoccurrenceStringElement;
Public property primarySource : boolean read GetprimarySource write SetprimarySource;
Public property primarySourceElement : Tboolean read GetprimarySourceElement write SetprimarySourceElement;
Public property informationSource : TCodeableReference read GetinformationSource write SetinformationSource;
Public property location : TReference read Getlocation write Setlocation;
Public property site : TCodeableConcept read Getsite write Setsite;
Public property route : TCodeableConcept read Getroute write Setroute;
Public property doseQuantity : TQuantity read GetdoseQuantity write SetdoseQuantity;
Public property performer : TImmunizationPerformerArray read GetperformerArray;
Public property note : TAnnotationArray read GetnoteArray;
Public property reason : TCodeableReferenceArray read GetreasonArray;
Public property isSubpotent : boolean read GetisSubpotent write SetisSubpotent;
Public property isSubpotentElement : Tboolean read GetisSubpotentElement write SetisSubpotentElement;
Public property subpotentReason : TCodeableConceptArray read GetsubpotentReasonArray;
Public property programEligibility : TImmunizationProgramEligibilityArray read GetprogramEligibilityArray;
Public property fundingSource : TCodeableConcept read GetfundingSource write SetfundingSource;
Public property reaction : TImmunizationReactionArray read GetreactionArray;
Public property protocolApplied : TImmunizationProtocolAppliedArray read GetprotocolAppliedArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;

A unique identifier assigned to this immunization record.

Public property basedOn : TReferenceArray read GetbasedOnArray;

A plan, order or recommendation fulfilled in whole or in part by this immunization.

Public property status : string read Getstatus write Setstatus;

Indicates the current status of the immunization event.

Public property statusElement : TImmunizationStatusCodes read GetstatusElement write SetstatusElement;
 
Public property statusReason : TCodeableConcept read GetstatusReason write SetstatusReason;

Indicates the reason the immunization event was not performed.

Public property vaccineCode : TCodeableConcept read GetvaccineCode write SetvaccineCode;

Vaccine that was administered or was to be administered.

Public property administeredProduct : TCodeableReference read GetadministeredProduct write SetadministeredProduct;

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.

Public property manufacturer : TCodeableReference read Getmanufacturer write Setmanufacturer;

Name of vaccine manufacturer.

Public property lotNumber : string read GetlotNumber write SetlotNumber;

Lot number of the vaccine product.

Public property lotNumberElement : Tstring read GetlotNumberElement write SetlotNumberElement;
 
Public property expirationDate : string read GetexpirationDate write SetexpirationDate;

Date vaccine batch expires.

Public property expirationDateElement : Tdate_ read GetexpirationDateElement write SetexpirationDateElement;
 
Public property patient : TReference read Getpatient write Setpatient;

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

Public property encounter : TReference read Getencounter write Setencounter;

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

Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;

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.

Public property occurrenceDateTime : string read GetoccurrenceDateTime write SetoccurrenceDateTime;

Date vaccine administered or was to be administered. (choose any one of occurrence*, but only one)

Public property occurrenceDateTimeElement : TdateTime_ read GetoccurrenceDateTimeElement write SetoccurrenceDateTimeElement;
 
Public property occurrenceString : string read GetoccurrenceString write SetoccurrenceString;

Date vaccine administered or was to be administered. (choose any one of occurrence*, but only one)

Public property occurrenceStringElement : Tstring read GetoccurrenceStringElement write SetoccurrenceStringElement;
 
Public property primarySource : boolean read GetprimarySource write SetprimarySource;

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.

Public property primarySourceElement : Tboolean read GetprimarySourceElement write SetprimarySourceElement;
 
Public property informationSource : TCodeableReference read GetinformationSource write SetinformationSource;

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.

Public property location : TReference read Getlocation write Setlocation;

The service delivery location where the vaccine administration occurred.

Public property site : TCodeableConcept read Getsite write Setsite;

Body site where vaccine was administered.

Public property route : TCodeableConcept read Getroute write Setroute;

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

Public property doseQuantity : TQuantity read GetdoseQuantity write SetdoseQuantity;

The quantity of vaccine product that was administered.

Public property performer : TImmunizationPerformerArray read GetperformerArray;

Indicates who performed the immunization event.

Public property note : TAnnotationArray read GetnoteArray;

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

Public property reason : TCodeableReferenceArray read GetreasonArray;

Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.

Public property isSubpotent : boolean read GetisSubpotent write SetisSubpotent;

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

Public property isSubpotentElement : Tboolean read GetisSubpotentElement write SetisSubpotentElement;
 
Public property subpotentReason : TCodeableConceptArray read GetsubpotentReasonArray;

Reason why a dose is considered to be subpotent.

Public property programEligibility : TImmunizationProgramEligibilityArray read GetprogramEligibilityArray;

Indicates a patient's eligibility for a funding program.

Public property fundingSource : TCodeableConcept read GetfundingSource write SetfundingSource;

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

Public property reaction : TImmunizationReactionArray read GetreactionArray;

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

Public property protocolApplied : TImmunizationProtocolAppliedArray read GetprotocolAppliedArray;

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

Generated by PasDoc 0.15.0.