Class: FHIR::R4::Immunization

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

Defined Under Namespace

Classes: Education, Performer, 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' => {'valid_codes'=>{'urn:ietf:bcp:47'=>['ar', 'bn', 'cs', 'da', 'de', 'de-AT', 'de-CH', 'de-DE', 'el', 'en', 'en-AU', 'en-CA', 'en-GB', 'en-IN', 'en-NZ', 'en-SG', 'en-US', 'es', 'es-AR', 'es-ES', 'es-UY', 'fi', 'fr', 'fr-BE', 'fr-CH', 'fr-FR', 'fy', 'fy-NL', 'hi', 'hr', 'it', 'it-CH', 'it-IT', 'ja', 'ko', 'nl', 'nl-BE', 'nl-NL', 'no', 'no-NO', 'pa', 'pl', 'pt', 'pt-BR', 'ru', 'ru-RU', 'sr', 'sr-RS', 'sv', 'sv-SE', 'te', 'zh', 'zh-CN', 'zh-HK', 'zh-SG', 'zh-TW']}, 'type'=>'code', 'path'=>'Immunization.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/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},
  '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'], 'http://snomed.info/sct'=>['171257003', '171265000', '171266004', '171267008', '171268003', '171269006', '171270007', '171271006', '171272004', '171280006', '171283008', '171285001', '171286000', '171291004', '171292006', '171293001', '268559007', '310839003', '310840001', '314768003', '314769006', '314936001', '407598009']}, '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'=>['143', '54', '55', '82', '24', '181', '801', '19', '27', '173', '174', '26', '172', '29', '56', '12', '28', '20', '106', '107', '146', '110', '50', '120', '130', '132', '170', '01', '22', '102', '57', '30', '52', '154', '169', '83', '84', '31', '85', '104', '193', '08', '42', '43', '44', '45', '58', '59', '189', '60', '47', '46', '49', '48', '17', '51', '61', '118', '62', '137', '165', '86', '14', '87', '160', '151', '123', '135', '153', '171', '186', '158', '150', '161', '166', '111', '149', '155', '185', '141', '140', '144', '15', '168', '88', '16', '10', '134', '39', '129', '63', '64', '65', '66', '04', '67', '05', '68', '191', '192', '108', '163', '162', '164', '103', '148', '147', '136', '114', '32', '167', '03', '94', '07', '127', '128', '125', '126', '02', '179', '178', '182', '69', '177', '11', '23', '133', '100', '152', '33', '109', '89', '70', '175', '176', '40', '18', '90', '72', '159', '157', '156', '73', '34', '119', '116', '74', '122', '71', '93', '145', '06', '38', '76', '138', '09', '113', '139', '115', '180', '35', '142', '112', '77', '13', '98', '95', '96', '97', '78', '190', '25', '41', '53', '91', '101', '131', '75', '105', '79', '21', '81', '80', '92', '36', '117', '37', '183', '184', '121', '187', '188', '998', '99', '999'], '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'}},
  '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},
  'occurrenceDateTime' => {'type'=>'dateTime', 'path'=>'Immunization.occurrence[x]', 'min'=>1, 'max'=>1},
  'occurrenceString' => {'type'=>'string', 'path'=>'Immunization.occurrence[x]', 'min'=>1, 'max'=>1},
  'recorded' => {'type'=>'dateTime', 'path'=>'Immunization.recorded', 'min'=>0, 'max'=>1},
  'primarySource' => {'type'=>'boolean', 'path'=>'Immunization.primarySource', 'min'=>0, 'max'=>1},
  'reportOrigin' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/immunization-origin'=>['provider', 'record', 'recall', 'school']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.reportOrigin', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-origin'}},
  'location' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Location'], 'type'=>'Reference', 'path'=>'Immunization.location', 'min'=>0, 'max'=>1},
  'manufacturer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', '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},
  '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', 'NASINHLC', '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},
  'reasonCode' => {'valid_codes'=>{'http://snomed.info/sct'=>['429060002', '281657000']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.reasonCode', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-reason'}},
  'reasonReference' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/Observation', 'http://hl7.org/fhir/StructureDefinition/DiagnosticReport'], 'type'=>'Reference', 'path'=>'Immunization.reasonReference', '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'=>['partial', 'coldchainbreak', 'recall']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.subpotentReason', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-subpotent-reason'}},
  'education' => {'type'=>'Immunization::Education', 'path'=>'Immunization.education', 'min'=>0, 'max'=>Float::INFINITY},
  'programEligibility' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/immunization-program-eligibility'=>['ineligible', 'uninsured']}, 'type'=>'CodeableConcept', 'path'=>'Immunization.programEligibility', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-program-eligibility'}},
  '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

PRIMITIVES, RESOURCES, 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

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

#containedObject

0-* [ Resource ]



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

def contained
  @contained
end

#doseQuantityObject

0-1 Quantity



177
178
179
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 177

def doseQuantity
  @doseQuantity
end

#educationObject

0-* [ Immunization::Education ]



184
185
186
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 184

def education
  @education
end

#encounterObject

0-1 Reference(Encounter)



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

def encounter
  @encounter
end

#expirationDateObject

0-1 date



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

def expirationDate
  @expirationDate
end

#extensionObject

0-* [ Extension ]



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

def extension
  @extension
end

#fundingSourceObject

0-1 CodeableConcept



186
187
188
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 186

def fundingSource
  @fundingSource
end

#idObject

0-1 id



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

def id
  @id
end

#identifierObject

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRulesObject

0-1 uri



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

def implicitRules
  @implicitRules
end

#isSubpotentObject

0-1 boolean



182
183
184
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 182

def isSubpotent
  @isSubpotent
end

#languageObject

0-1 code



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

def language
  @language
end

#locationObject

0-1 Reference(Location)



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

def location
  @location
end

#lotNumberObject

0-1 string



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

def lotNumber
  @lotNumber
end

#manufacturerObject

0-1 Reference(Organization)



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

def manufacturer
  @manufacturer
end

#metaObject

0-1 Meta



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

def meta
  @meta
end

#modifierExtensionObject

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#noteObject

0-* [ Annotation ]



179
180
181
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 179

def note
  @note
end

#occurrenceDateTimeObject

1-1 dateTime



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

def occurrenceDateTime
  @occurrenceDateTime
end

#occurrenceStringObject

1-1 string



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

def occurrenceString
  @occurrenceString
end

#patientObject

1-1 Reference(Patient)



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

def patient
  @patient
end

#performerObject

0-* [ Immunization::Performer ]



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

def performer
  @performer
end

#primarySourceObject

0-1 boolean



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

def primarySource
  @primarySource
end

#programEligibilityObject

0-* [ CodeableConcept ]



185
186
187
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 185

def programEligibility
  @programEligibility
end

#protocolAppliedObject

0-* [ Immunization::ProtocolApplied ]



188
189
190
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 188

def protocolApplied
  @protocolApplied
end

#reactionObject

0-* [ Immunization::Reaction ]



187
188
189
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 187

def reaction
  @reaction
end

#reasonCodeObject

0-* [ CodeableConcept ]



180
181
182
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 180

def reasonCode
  @reasonCode
end

#reasonReferenceObject

0-* [ Reference(Condition|Observation|DiagnosticReport) ]



181
182
183
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 181

def reasonReference
  @reasonReference
end

#recordedObject

0-1 dateTime



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

def recorded
  @recorded
end

#reportOriginObject

0-1 CodeableConcept



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

def reportOrigin
  @reportOrigin
end

#routeObject

0-1 CodeableConcept



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

def route
  @route
end

#siteObject

0-1 CodeableConcept



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

def site
  @site
end

#statusObject

1-1 code



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

def status
  @status
end

#statusReasonObject

0-1 CodeableConcept



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

def statusReason
  @statusReason
end

#subpotentReasonObject

0-* [ CodeableConcept ]



183
184
185
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 183

def subpotentReason
  @subpotentReason
end

#textObject

0-1 Narrative



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

def text
  @text
end

#vaccineCodeObject

1-1 CodeableConcept



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

def vaccineCode
  @vaccineCode
end

Instance Method Details

#resourceTypeObject



190
191
192
# File 'lib/fhir_models/r4/generated/resources/Immunization.rb', line 190

def resourceType
  'Immunization'
end