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: Explanation, Practitioner, Reaction, VaccinationProtocol

Constant Summary collapse

SEARCH_PARAMS = 
['date', 'identifier', 'patient', 'dose-sequence', 'location', 'lot-number', 'manufacturer', 'notgiven', 'practitioner', 'reaction', 'reaction-date', 'reason', 'reason-not-given', 'status', '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', 'pt', 'pt-BR', 'ru', 'ru-RU', 'sr', 'sr-SP', 'sv', 'sv-SE', 'te', 'zh', 'zh-CN', 'zh-HK', 'zh-SG', 'zh-TW']}, 'type'=>'code', 'path'=>'Immunization.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', '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/medication-admin-status'=>['completed', 'entered-in-error', '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'}},
  'notGiven' => {'type'=>'boolean', 'path'=>'Immunization.notGiven', 'min'=>1, 'max'=>1},
  'vaccineCode' => {'valid_codes'=>{'http://hl7.org/fhir/sid/cvx'=>['01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '100', '101', '102', '103', '104', '105', '106', '107', '108', '109', '11', '110', '111', '112', '113', '114', '115', '116', '117', '118', '119', '12', '120', '121', '122', '123', '125', '126', '127', '128', '129', '13', '130', '131', '132', '133', '134', '135', '136', '137', '138', '139', '14', '140', '141', '142', '143', '144', '145', '146', '147', '148', '149', '15', '150', '151', '152', '153', '154', '155', '156', '157', '158', '159', '16', '160', '161', '162', '163', '164', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '801', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '998', '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},
  'date' => {'type'=>'dateTime', 'path'=>'Immunization.date', 'min'=>0, 'max'=>1},
  'primarySource' => {'type'=>'boolean', 'path'=>'Immunization.primarySource', 'min'=>1, 'max'=>1},
  'reportOrigin' => {'valid_codes'=>{'http://hl7.org/fhir/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://hl7.org/fhir/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://hl7.org/fhir/v3/RouteOfAdministration'=>['IM', 'PO', 'NASINHL']}, '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},
  'practitioner' => {'type'=>'Immunization::Practitioner', 'path'=>'Immunization.practitioner', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'Immunization.note', 'min'=>0, 'max'=>Float::INFINITY},
  'explanation' => {'type'=>'Immunization::Explanation', 'path'=>'Immunization.explanation', 'min'=>0, 'max'=>1},
  'reaction' => {'type'=>'Immunization::Reaction', 'path'=>'Immunization.reaction', 'min'=>0, 'max'=>Float::INFINITY},
  'vaccinationProtocol' => {'type'=>'Immunization::VaccinationProtocol', 'path'=>'Immunization.vaccinationProtocol', '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 ]



139
140
141
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 139

def contained
  @contained
end

#date ⇒ Object

0-1 dateTime



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

def date
  @date
end

#doseQuantity ⇒ Object

0-1 Quantity



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

def doseQuantity
  @doseQuantity
end

#encounter ⇒ Object

0-1 Reference(Encounter)



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

def encounter
  @encounter
end

#expirationDate ⇒ Object

0-1 date



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

def expirationDate
  @expirationDate
end

#explanation ⇒ Object

0-1 Immunization::Explanation



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

def explanation
  @explanation
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#id ⇒ Object

0-1 id



134
135
136
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 134

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



136
137
138
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 136

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



137
138
139
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 137

def language
  @language
end

#location ⇒ Object

0-1 Reference(Location)



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

def location
  @location
end

#lotNumber ⇒ Object

0-1 string



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

def lotNumber
  @lotNumber
end

#manufacturer ⇒ Object

0-1 Reference(Organization)



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

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



135
136
137
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 135

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



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

def note
  @note
end

#notGiven ⇒ Object

1-1 boolean



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

def notGiven
  @notGiven
end

#patient ⇒ Object

1-1 Reference(Patient)



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

def patient
  @patient
end

#practitioner ⇒ Object

0-* [ Immunization::Practitioner ]



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

def practitioner
  @practitioner
end

#primarySource ⇒ Object

1-1 boolean



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

def primarySource
  @primarySource
end

#reaction ⇒ Object

0-* [ Immunization::Reaction ]



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

def reaction
  @reaction
end

#reportOrigin ⇒ Object

0-1 CodeableConcept



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

def reportOrigin
  @reportOrigin
end

#route ⇒ Object

0-1 CodeableConcept



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

def route
  @route
end

#site ⇒ Object

0-1 CodeableConcept



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

def site
  @site
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#text ⇒ Object

0-1 Narrative



138
139
140
 
# File 'lib/fhir_models/fhir/resources/Immunization.rb', line 138

def text
  @text
end

#vaccinationProtocol ⇒ Object

0-* [ Immunization::VaccinationProtocol ]



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

def vaccinationProtocol
  @vaccinationProtocol
end

#vaccineCode ⇒ Object

1-1 CodeableConcept



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

def vaccineCode
  @vaccineCode
end

Instance Method Details

#resourceType ⇒ Object 



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

def resourceType
  'Immunization'
end