Class: FHIR::Immunization

Inherits:
Model
  • Object
show all
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/fhir/resources/Immunization.rb

Defined Under Namespace

Classes: Education, Performer, ProtocolApplied, Reaction

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'occurrence' => ['dateTime', 'string']
}
SEARCH_PARAMS = 
['date', 'identifier', 'patient', 'location', 'lot-number', 'manufacturer', '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', 'preparation', 'in-progress', 'on-hold', 'stopped', 'unknown']}, 'type'=>'code', 'path'=>'Immunization.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/immunization-status|4.0.0'}},
  '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', 'jurisdiction']}, '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}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Xml

from_xml, #to_xml, valid?, validate

Methods included from Deprecate

#deprecate

Methods included from Json

from_json, #to_json

Methods included from Hashable

#from_hash, #to_hash

Methods inherited from Model

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

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

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#doseQuantity ⇒ Object

0-1 Quantity



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

def doseQuantity
  @doseQuantity
end

#education ⇒ Object

0-* [ Immunization::Education ]



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

def education
  @education
end

#encounter ⇒ Object

0-1 Reference(Encounter)



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

def encounter
  @encounter
end

#expirationDate ⇒ Object

0-1 date



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

def expirationDate
  @expirationDate
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#fundingSource ⇒ Object

0-1 CodeableConcept



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

def fundingSource
  @fundingSource
end

#id ⇒ Object

0-1 id



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

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#isSubpotent ⇒ Object

0-1 boolean



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

def isSubpotent
  @isSubpotent
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#location ⇒ Object

0-1 Reference(Location)



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

def location
  @location
end

#lotNumber ⇒ Object

0-1 string



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

def lotNumber
  @lotNumber
end

#manufacturer ⇒ Object

0-1 Reference(Organization)



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

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



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

def note
  @note
end

#occurrenceDateTime ⇒ Object

1-1 dateTime



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

def occurrenceDateTime
  @occurrenceDateTime
end

#occurrenceString ⇒ Object

1-1 string



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

def occurrenceString
  @occurrenceString
end

#patient ⇒ Object

1-1 Reference(Patient)



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

def patient
  @patient
end

#performer ⇒ Object

0-* [ Immunization::Performer ]



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

def performer
  @performer
end

#primarySource ⇒ Object

0-1 boolean



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

def primarySource
  @primarySource
end

#programEligibility ⇒ Object

0-* [ CodeableConcept ]



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

def programEligibility
  @programEligibility
end

#protocolApplied ⇒ Object

0-* [ Immunization::ProtocolApplied ]



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

def protocolApplied
  @protocolApplied
end

#reaction ⇒ Object

0-* [ Immunization::Reaction ]



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

def reaction
  @reaction
end

#reasonCode ⇒ Object

0-* [ CodeableConcept ]



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

def reasonCode
  @reasonCode
end

#reasonReference ⇒ Object

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



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

def reasonReference
  @reasonReference
end

#recorded ⇒ Object

0-1 dateTime



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

def recorded
  @recorded
end

#reportOrigin ⇒ Object

0-1 CodeableConcept



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

def reportOrigin
  @reportOrigin
end

#route ⇒ Object

0-1 CodeableConcept



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

def route
  @route
end

#site ⇒ Object

0-1 CodeableConcept



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

def site
  @site
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#statusReason ⇒ Object

0-1 CodeableConcept



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

def statusReason
  @statusReason
end

#subpotentReason ⇒ Object

0-* [ CodeableConcept ]



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

def subpotentReason
  @subpotentReason
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#vaccineCode ⇒ Object

1-1 CodeableConcept



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

def vaccineCode
  @vaccineCode
end

Instance Method Details

#resourceType ⇒ Object 



189
190
191
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 189

def resourceType
  'Immunization'
end