Class: FHIR::R5::Immunization

Inherits:
Model show all
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/r5/generated/resources/Immunization.rb

Defined Under Namespace

Classes: Performer, ProgramEligibility, ProtocolApplied, Reaction

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'occurrence' => ['dateTime', 'string']
}
SEARCH_PARAMS = 
['date', 'identifier', 'location', 'lot-number', 'manufacturer', 'patient', 'performer', 'reaction', 'reaction-date', 'reason-code', 'reason-reference', 'series', 'status', 'status-reason', 'target-disease', 'vaccine-code']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'Immunization.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'Immunization.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'Immunization.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'Immunization.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'additional'=>[{'purpose'=>'starter', 'valueSet'=>'http://hl7.org/fhir/ValueSet/languages'}], 'uri'=>'http://hl7.org/fhir/ValueSet/all-languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'Immunization.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'Immunization.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'Immunization.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Immunization.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'Immunization.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'basedOn' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest', 'http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation'], 'type'=>'Reference', 'path'=>'Immunization.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/event-status'=>['completed', 'entered-in-error', 'not-done']}, 'type'=>'code', 'path'=>'Immunization.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-status'}},
  'statusReason' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ActReason'=>['IMMUNE', 'MEDPREC', 'OSTOCK', 'PATOBJ', 'PHILISOP', 'RELIG', 'VACEFF', 'VACSAF']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.statusReason', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-status-reason'}},
  'vaccineCode' => {'valid_codes'=>{'http://hl7.org/fhir/sid/cvx'=>['54', '55', '82', '24', '19', '27', '26', '29', '56', '12', '28', '20', '106', '107', '110', '50', '120', '130', '01', '22', '102', '57', '52', '83', '84', '31', '85', '104', '30', '08', '42', '43', '44', '45', '58', '59', '60', '46', '47', '48', '49', '17', '51', '61', '118', '62', '86', '87', '14', '111', '15', '16', '88', '123', '10', '02', '89', '39', '63', '64', '65', '66', '03', '04', '94', '67', '05', '68', '32', '103', '114', '108', '07', '69', '11', '23', '33', '100', '109', '70', '18', '40', '90', '72', '73', '34', '119', '122', '116', '74', '71', '93', '06', '38', '76', '113', '09', '115', '35', '112', '77', '13', '95', '96', '97', '98', '78', '91', '25', '41', '53', '101', '75', '105', '79', '21', '81', '80', '92', '36', '117', '37', '121', '998', '999', '99', '133', '134', '137', '136', '135', '131', '132', '128', '125', '126', '127', '138', '139', '140', '129', '141', '142', '143', '144', '145', '146', '147', '148', '149', '150', '151', '152', '153', '154', '155', '156', '157', '158', '159', '160', '801', '161', '162', '163', '164', '165', '166', '167', '168', '169', '170', '171', '172', '173', '174', '175', '176', '177', '178', '179', '180', '181', '182', '183', '184', '185', '186', '187', '188', '189', '190', '191', '192', '193', '194', '195', '196', '197', '200', '201', '202', '198', '203', '205', '206', '207', '208', '213', '210', '212', '204', '214', '211'], 'urn:oid:1.2.36.1.2001.1005.17'=>['AGRPAL', 'AVAXM', 'BCG', 'CDT', 'CMX', 'DTP', 'DTPA', 'ENGP', 'FLRIX', 'FLUVAX', 'FLVRN', 'FVXJNR', 'GNDIP', 'GNFLU', 'GNHEP', 'GNHIB', 'GNHPA', 'GNJEN', 'GNMEA', 'GNMEN', 'GNMUM', 'GNPNE', 'GNPOL', 'GNROX', 'GNRUB', 'GNTET', 'GNVAR', 'HATWNJ', 'HAVAQ', 'HAVJ', 'HBOC', 'HBV', 'HBVP', 'HBX', 'IFHX', 'IFIP', 'IFPA', 'IFX', 'IFXB', 'INFLUV', 'IPV', 'JEVAX', 'MENJUG', 'MENTEC', 'MENUME', 'MENVAX', 'MMR', 'MMRCSL', 'MMRSKB', 'MNTRX', 'NEISVC', 'OPV', 'P', 'PANVAX', 'PDCL', 'PLCL', 'PNEUMO', 'PRPD', 'PROQAD', 'PRPOMP', 'PRPT', 'PRVNR', 'PRVTH', 'PRXTEX', 'QDCL', 'ROTRIX', 'ROTTEQ', 'SYNFLX', 'TCL', 'VAXGRP', 'VGRJNR', 'VLRIX', 'VRVAX']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.vaccineCode', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/vaccine-code'}},
  'administeredProduct' => {'type'=>'CodeableReference', 'path'=>'Immunization.administeredProduct', 'min'=>0, 'max'=>1},
  'manufacturer' => {'type'=>'CodeableReference', 'path'=>'Immunization.manufacturer', 'min'=>0, 'max'=>1},
  'lotNumber' => {'type'=>'string', 'path'=>'Immunization.lotNumber', 'min'=>0, 'max'=>1},
  'expirationDate' => {'type'=>'date', 'path'=>'Immunization.expirationDate', 'min'=>0, 'max'=>1},
  'patient' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient'], 'type'=>'Reference', 'path'=>'Immunization.patient', 'min'=>1, 'max'=>1},
  'encounter' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'Immunization.encounter', 'min'=>0, 'max'=>1},
  'supportingInformation' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'Immunization.supportingInformation', 'min'=>0, 'max'=>Float::INFINITY},
  'occurrenceDateTime' => {'type'=>'dateTime', 'path'=>'Immunization.occurrence[x]', 'min'=>1, 'max'=>1},
  'occurrenceString' => {'type'=>'string', 'path'=>'Immunization.occurrence[x]', 'min'=>1, 'max'=>1},
  'primarySource' => {'type'=>'boolean', 'path'=>'Immunization.primarySource', 'min'=>0, 'max'=>1},
  'informationSource' => {'type'=>'CodeableReference', 'path'=>'Immunization.informationSource', 'min'=>0, 'max'=>1},
  'location' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Location'], 'type'=>'Reference', 'path'=>'Immunization.location', 'min'=>0, 'max'=>1},
  'site' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ActSite'=>['LA', 'RA']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.site', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-site'}},
  'route' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration'=>['IDINJ', 'IM', 'IVINJ', 'PO', 'SQ', 'TRNSDERM']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.route', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-route'}},
  'doseQuantity' => {'type'=>'Quantity', 'path'=>'Immunization.doseQuantity', 'min'=>0, 'max'=>1},
  'performer' => {'type'=>'Immunization::Performer', 'path'=>'Immunization.performer', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'Immunization.note', 'min'=>0, 'max'=>Float::INFINITY},
  'reason' => {'type'=>'CodeableReference', 'path'=>'Immunization.reason', 'min'=>0, 'max'=>Float::INFINITY},
  'isSubpotent' => {'type'=>'boolean', 'path'=>'Immunization.isSubpotent', 'min'=>0, 'max'=>1},
  'subpotentReason' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason'=>['partialdose', 'coldchainbreak', 'recall', 'adversestorage', 'expired']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.subpotentReason', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-subpotent-reason'}},
  'programEligibility' => {'type'=>'Immunization::ProgramEligibility', 'path'=>'Immunization.programEligibility', 'min'=>0, 'max'=>Float::INFINITY},
  'fundingSource' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/immunization-funding-source'=>['private', 'public']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.fundingSource', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-funding-source'}},
  'reaction' => {'type'=>'Immunization::Reaction', 'path'=>'Immunization.reaction', 'min'=>0, 'max'=>Float::INFINITY},
  'protocolApplied' => {'type'=>'Immunization::ProtocolApplied', 'path'=>'Immunization.protocolApplied', 'min'=>0, 'max'=>Float::INFINITY}
}

Constants included from FHIR::R4

FHIR::R4::PRIMITIVES, FHIR::R4::RESOURCES, FHIR::R4::TYPES

Constants included from FHIR

Account, ActivityDefinition, Address, AdverseEvent, Age, AllergyIntolerance, Annotation, Appointment, AppointmentResponse, Attachment, AuditEvent, BackboneElement, Basic, Binary, BiologicallyDerivedProduct, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CodeSystem, CodeableConcept, Coding, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, Consent, ContactDetail, ContactPoint, Contract, Contributor, Count, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DataRequirement, Definitions, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, Distance, DocumentManifest, DocumentReference, DomainResource, Dosage, Duration, EffectEvidenceSynthesis, Element, ElementDefinition, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, Expression, Extension, FamilyMemberHistory, Flag, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, HumanName, Identifier, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, InsurancePlan, Invoice, Library, Linkage, List, Location, MarketingStatus, Measure, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MessageDefinition, MessageHeader, Meta, MolecularSequence, Money, NamingSystem, Narrative, NutritionOrder, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PRIMITIVES, ParameterDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Period, Person, PlanDefinition, Population, Practitioner, PractitionerRole, Procedure, ProdCharacteristic, ProductShelfLife, Provenance, Quantity, Questionnaire, QuestionnaireResponse, FHIR::RESOURCES, FHIR::Range, FHIR::Ratio, FHIR::Reference, FHIR::RelatedArtifact, FHIR::RelatedPerson, FHIR::RequestGroup, FHIR::ResearchDefinition, FHIR::ResearchElementDefinition, FHIR::ResearchStudy, FHIR::ResearchSubject, FHIR::Resource, FHIR::RiskAssessment, FHIR::RiskEvidenceSynthesis, SampledData, Schedule, SearchParameter, ServiceRequest, Signature, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureDefinitionCompare, StructureMap, Subscription, Substance, SubstanceAmount, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, TYPES, Task, TerminologyCapabilities, TestReport, TestScript, Timing, TriggerDefinition, UsageContext, ValueSet, VerificationResult, VisionPrescription

Constants included from FHIR::R5

PRIMITIVES, RESOURCES, TYPES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FHIR::R4

#fhir_version_string, #versioned_fhir_module

Methods included from FHIR

default_logger, fhir_version_string, logger, logger=, primitive?, versioned_fhir_module

Methods included from ClassMethods

#from_contents

Methods included from ClassXml

#from_xml, #valid?, #validate, #xml_node_to_hash

Methods included from InstanceXml

#hash_to_xml_node, #to_xml

Methods included from ClassJson

#from_json

Methods included from InstanceJson

#to_json

Methods included from Hashable

#from_hash, #to_hash

Methods included from FHIR::R5

#fhir_version_string, #versioned_fhir_module

Methods inherited from Model

#==, #attribute_mismatch, #compare_attribute, #each_element, #equals?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #respond_to_missing?, #to_reference, #valid?, #validate, #validate_profile

Methods included from Deprecate

#deprecate

Constructor Details

This class inherits a constructor from FHIR::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class FHIR::Model

Instance Attribute Details

#administeredProduct ⇒ Object

0-1 CodeableReference



153
154
155
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 153

def administeredProduct
  @administeredProduct
end

#basedOn ⇒ Object

0-* [ Reference(CarePlan|MedicationRequest|ServiceRequest|ImmunizationRecommendation) ]



149
150
151
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 149

def basedOn
  @basedOn
end

#contained ⇒ Object

0-* [ Resource ]



145
146
147
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 145

def contained
  @contained
end

#doseQuantity ⇒ Object

0-1 Quantity



167
168
169
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 167

def doseQuantity
  @doseQuantity
end

#encounter ⇒ Object

0-1 Reference(Encounter)



158
159
160
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 158

def encounter
  @encounter
end

#expirationDate ⇒ Object

0-1 date



156
157
158
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 156

def expirationDate
  @expirationDate
end

#extension ⇒ Object

0-* [ Extension ]



146
147
148
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 146

def extension
  @extension
end

#fundingSource ⇒ Object

0-1 CodeableConcept



174
175
176
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 174

def fundingSource
  @fundingSource
end

#id ⇒ Object

0-1 id



140
141
142
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 140

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



148
149
150
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 148

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



142
143
144
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 142

def implicitRules
  @implicitRules
end

#informationSource ⇒ Object

0-1 CodeableReference



163
164
165
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 163

def informationSource
  @informationSource
end

#isSubpotent ⇒ Object

0-1 boolean



171
172
173
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 171

def isSubpotent
  @isSubpotent
end

#language ⇒ Object

0-1 code



143
144
145
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 143

def language
  @language
end

#location ⇒ Object

0-1 Reference(Location)



164
165
166
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 164

def location
  @location
end

#lotNumber ⇒ Object

0-1 string



155
156
157
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 155

def lotNumber
  @lotNumber
end

#manufacturer ⇒ Object

0-1 CodeableReference



154
155
156
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 154

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



141
142
143
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 141

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



147
148
149
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 147

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



169
170
171
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 169

def note
  @note
end

#occurrenceDateTime ⇒ Object

1-1 dateTime



160
161
162
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 160

def occurrenceDateTime
  @occurrenceDateTime
end

#occurrenceString ⇒ Object

1-1 string



161
162
163
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 161

def occurrenceString
  @occurrenceString
end

#patient ⇒ Object

1-1 Reference(Patient)



157
158
159
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 157

def patient
  @patient
end

#performer ⇒ Object

0-* [ Immunization::Performer ]



168
169
170
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 168

def performer
  @performer
end

#primarySource ⇒ Object

0-1 boolean



162
163
164
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 162

def primarySource
  @primarySource
end

#programEligibility ⇒ Object

0-* [ Immunization::ProgramEligibility ]



173
174
175
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 173

def programEligibility
  @programEligibility
end

#protocolApplied ⇒ Object

0-* [ Immunization::ProtocolApplied ]



176
177
178
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 176

def protocolApplied
  @protocolApplied
end

#reaction ⇒ Object

0-* [ Immunization::Reaction ]



175
176
177
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 175

def reaction
  @reaction
end

#reason ⇒ Object

0-* [ CodeableReference ]



170
171
172
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 170

def reason
  @reason
end

#route ⇒ Object

0-1 CodeableConcept



166
167
168
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 166

def route
  @route
end

#site ⇒ Object

0-1 CodeableConcept



165
166
167
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 165

def site
  @site
end

#status ⇒ Object

1-1 code



150
151
152
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 150

def status
  @status
end

#statusReason ⇒ Object

0-1 CodeableConcept



151
152
153
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 151

def statusReason
  @statusReason
end

#subpotentReason ⇒ Object

0-* [ CodeableConcept ]



172
173
174
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 172

def subpotentReason
  @subpotentReason
end

#supportingInformation ⇒ Object

0-* [ Reference(Resource) ]



159
160
161
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 159

def supportingInformation
  @supportingInformation
end

#text ⇒ Object

0-1 Narrative



144
145
146
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 144

def text
  @text
end

#vaccineCode ⇒ Object

1-1 CodeableConcept



152
153
154
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 152

def vaccineCode
  @vaccineCode
end

Instance Method Details

#resourceType ⇒ Object 



178
179
180
 
# File 'lib/fhir_models/r5/generated/resources/Immunization.rb', line 178

def resourceType
  'Immunization'
end