Class: FHIR::DSTU2::Immunization

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

Defined Under Namespace

Classes: Explanation, Reaction, VaccinationProtocol

Constant Summary collapse

SEARCH_PARAMS = 
['date', 'dose-number', 'dose-sequence', 'identifier', 'information', 'patient', 'status', 'support', 'vaccine-type', 'date', 'dose-sequence', 'identifier', 'location', 'lot-number', 'manufacturer', 'notgiven', 'patient', 'performer', 'reaction', 'reaction-date', 'reason', 'reason-not-given', 'requester', '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' => {'type'=>'code', 'path'=>'Immunization.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://tools.ietf.org/html/bcp47'}},
  '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'=>['in-progress', 'on-hold', 'completed', 'entered-in-error', 'stopped']}, 'type'=>'code', 'path'=>'Immunization.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/medication-admin-status'}},
  'date' => {'type'=>'dateTime', 'path'=>'Immunization.date', 'min'=>0, 'max'=>1},
  'vaccineCode' => {'valid_codes'=>{'http://hl7.org/fhir/sid/cvx'=>[], 'urn:oid:1.2.36.1.2001.1005.17'=>[]}, 'type'=>'CodeableConcept', 'path'=>'Immunization.vaccineCode', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/vaccine-code'}},
  'patient' => {'type'=>'Reference', 'path'=>'Immunization.patient', 'min'=>1, 'max'=>1},
  'wasNotGiven' => {'type'=>'boolean', 'path'=>'Immunization.wasNotGiven', 'min'=>1, 'max'=>1},
  'reported' => {'type'=>'boolean', 'path'=>'Immunization.reported', 'min'=>1, 'max'=>1},
  'performer' => {'type'=>'Reference', 'path'=>'Immunization.performer', 'min'=>0, 'max'=>1},
  'requester' => {'type'=>'Reference', 'path'=>'Immunization.requester', 'min'=>0, 'max'=>1},
  'encounter' => {'type'=>'Reference', 'path'=>'Immunization.encounter', 'min'=>0, 'max'=>1},
  'manufacturer' => {'type'=>'Reference', 'path'=>'Immunization.manufacturer', 'min'=>0, 'max'=>1},
  'location' => {'type'=>'Reference', 'path'=>'Immunization.location', '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'=>['_HumanActSite', '_HumanSubstanceAdministrationSite', 'BE', 'BN', 'BU', 'LA', 'LAC', 'LACF', 'LD', 'LE', 'LEJ', 'LF', 'LG', 'LH', 'LIJ', 'LLAQ', 'LLFA', 'LMFA', 'LN', 'LPC', 'LSC', 'LT', 'LUA', 'LUAQ', 'LUFA', 'LVG', 'LVL', 'OD', 'OS', 'OU', 'PA', 'PERIN', 'RA', 'RAC', 'RACF', 'RD', 'RE', 'REJ', 'RF', 'RG', 'RH', 'RIJ', 'RLAQ', 'RLFA', 'RMFA', 'RN', 'RPC', 'RSC', 'RT', 'RUA', 'RUAQ', 'RUFA', 'RVG', 'RVL']}, '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'=>['_RouteByMethod', 'SOAK', 'SHAMPOO', 'TRNSLING', 'PO', 'GARGLE', 'SUCK', '_Chew', 'CHEW', '_Diffusion', 'EXTCORPDIF', 'HEMODIFF', 'TRNSDERMD', '_Dissolve', 'DISSOLVE', 'SL', '_Douche', 'DOUCHE', '_ElectroOsmosisRoute', 'ELECTOSMOS', '_Enema', 'ENEMA', 'RETENEMA', '_Flush', 'IVFLUSH', '_Implantation', 'IDIMPLNT', 'IVITIMPLNT', 'SQIMPLNT', '_Infusion', 'EPI', 'IA', 'IC', 'ICOR', 'IOSSC', 'IT', 'IV', 'IVC', 'IVCC', 'IVCI', 'PCA', 'IVASCINFUS', 'SQINFUS', '_Inhalation', 'IPINHL', 'ORIFINHL', 'REBREATH', 'IPPB', 'NASINHL', 'NASINHLC', 'NEB', 'NASNEB', 'ORNEB', 'TRACH', 'VENT', 'VENTMASK', '_Injection', 'AMNINJ', 'BILINJ', 'CHOLINJ', 'CERVINJ', 'EPIDURINJ', 'EPIINJ', 'EPINJSP', 'EXTRAMNINJ', 'EXTCORPINJ', 'GBINJ', 'GINGINJ', 'BLADINJ', 'ENDOSININJ', 'HEMOPORT', 'IABDINJ', 'IAINJ', 'IAINJP', 'IAINJSP', 'IARTINJ', 'IBURSINJ', 'ICARDINJ', 'ICARDINJRP', 'ICARDINJSP', 'ICARINJP', 'ICARTINJ', 'ICAUDINJ', 'ICAVINJ', 'ICAVITINJ', 'ICEREBINJ', 'ICISTERNINJ', 'ICORONINJ', 'ICORONINJP', 'ICORPCAVINJ', 'IDINJ', 'IDISCINJ', 'IDUCTINJ', 'IDURINJ', 'IEPIDINJ', 'IEPITHINJ', 'ILESINJ', 'ILUMINJ', 'ILYMPJINJ', 'IM', 'IMD', 'IMZ', 'IMEDULINJ', 'INTERMENINJ', 'INTERSTITINJ', 'IOINJ', 'IOSSINJ', 'IOVARINJ', 'IPCARDINJ', 'IPERINJ', 'IPINJ', 'IPLRINJ', 'IPROSTINJ', 'IPUMPINJ', 'ISINJ', 'ISTERINJ', 'ISYNINJ', 'ITENDINJ', 'ITESTINJ', 'ITHORINJ', 'ITINJ', 'ITUBINJ', 'ITUMINJ', 'ITYMPINJ', 'IUINJ', 'IUINJC', 'IURETINJ', 'IVASCINJ', 'IVENTINJ', 'IVESINJ', 'IVINJ', 'IVINJBOL', 'IVPUSH', 'IVRPUSH', 'IVSPUSH', 'IVITINJ', 'PAINJ', 'PARENTINJ', 'PDONTINJ', 'PDPINJ', 'PDURINJ', 'PNINJ', 'PNSINJ', 'RBINJ', 'SCINJ', 'SLESINJ', 'SOFTISINJ', 'SQ', 'SUBARACHINJ', 'SUBMUCINJ', 'TRPLACINJ', 'TRTRACHINJ', 'URETHINJ', 'URETINJ', '_Insertion', 'CERVINS', 'IOSURGINS', 'IU', 'LPINS', 'PR', 'SQSURGINS', 'URETHINS', 'VAGINSI', '_Instillation', 'CECINSTL', 'EFT', 'ENTINSTL', 'GT', 'NGT', 'OGT', 'BLADINSTL', 'CAPDINSTL', 'CTINSTL', 'ETINSTL', 'GJT', 'IBRONCHINSTIL', 'IDUODINSTIL', 'IESOPHINSTIL', 'IGASTINSTIL', 'IILEALINJ', 'IOINSTL', 'ISININSTIL', 'ITRACHINSTIL', 'IUINSTL', 'JJTINSTL', 'LARYNGINSTIL', 'NASALINSTIL', 'NASOGASINSTIL', 'NTT', 'OJJ', 'OT', 'PDPINSTL', 'PNSINSTL', 'RECINSTL', 'RECTINSTL', 'SININSTIL', 'SOFTISINSTIL', 'TRACHINSTL', 'TRTYMPINSTIL', 'URETHINSTL', '_IontophoresisRoute', 'IONTO', '_Irrigation', 'GUIRR', 'IGASTIRR', 'ILESIRR', 'IOIRR', 'BLADIRR', 'BLADIRRC', 'BLADIRRT', 'RECIRR', '_LavageRoute', 'IGASTLAV', '_MucosalAbsorptionRoute', 'IDOUDMAB', 'ITRACHMAB', 'SMUCMAB', '_Nebulization', 'ETNEB', '_Rinse', 'DENRINSE', 'ORRINSE', '_SuppositoryRoute', 'URETHSUP', '_Swish', 'SWISHSPIT', 'SWISHSWAL', '_TopicalAbsorptionRoute', 'TTYMPTABSORP', '_TopicalApplication', 'DRESS', 'SWAB', 'TOPICAL', 'BUC', 'CERV', 'DEN', 'GIN', 'HAIR', 'ICORNTA', 'ICORONTA', 'IESOPHTA', 'IILEALTA', 'ILTOP', 'ILUMTA', 'IOTOP', 'LARYNGTA', 'MUC', 'NAIL', 'NASAL', 'OPTHALTA', 'ORALTA', 'ORMUC', 'OROPHARTA', 'PERIANAL', 'PERINEAL', 'PDONTTA', 'RECTAL', 'SCALP', 'OCDRESTA', 'SKIN', 'SUBCONJTA', 'TMUCTA', 'VAGINS', 'INSUF', 'TRNSDERM', '_RouteBySite', '_AmnioticFluidSacRoute', '_BiliaryRoute', '_BodySurfaceRoute', '_BuccalMucosaRoute', '_CecostomyRoute', '_CervicalRoute', '_EndocervicalRoute', '_EnteralRoute', '_EpiduralRoute', '_ExtraAmnioticRoute', '_ExtracorporealCirculationRoute', '_GastricRoute', '_GenitourinaryRoute', '_GingivalRoute', '_HairRoute', '_InterameningealRoute', '_InterstitialRoute', '_IntraabdominalRoute', '_IntraarterialRoute', '_IntraarticularRoute', '_IntrabronchialRoute', '_IntrabursalRoute', '_IntracardiacRoute', '_IntracartilaginousRoute', '_IntracaudalRoute', '_IntracavernosalRoute', '_IntracavitaryRoute', '_IntracerebralRoute', '_IntracervicalRoute', '_IntracisternalRoute', '_IntracornealRoute', '_IntracoronalRoute', '_IntracoronaryRoute', '_IntracorpusCavernosumRoute', '_IntradermalRoute', '_IntradiscalRoute', '_IntraductalRoute', '_IntraduodenalRoute', '_IntraduralRoute', '_IntraepidermalRoute', '_IntraepithelialRoute', '_IntraesophagealRoute', '_IntragastricRoute', '_IntrailealRoute', '_IntralesionalRoute', '_IntraluminalRoute', '_IntralymphaticRoute', '_IntramedullaryRoute', '_IntramuscularRoute', '_IntraocularRoute', '_IntraosseousRoute', '_IntraovarianRoute', '_IntrapericardialRoute', '_IntraperitonealRoute', '_IntrapleuralRoute', '_IntraprostaticRoute', '_IntrapulmonaryRoute', '_IntrasinalRoute', '_IntraspinalRoute', '_IntrasternalRoute', '_IntrasynovialRoute', '_IntratendinousRoute', '_IntratesticularRoute', '_IntrathecalRoute', '_IntrathoracicRoute', '_IntratrachealRoute', '_IntratubularRoute', '_IntratumorRoute', '_IntratympanicRoute', '_IntrauterineRoute', '_IntravascularRoute', '_IntravenousRoute', '_IntraventricularRoute', '_IntravesicleRoute', '_IntravitrealRoute', '_JejunumRoute', '_LacrimalPunctaRoute', '_LaryngealRoute', '_LingualRoute', '_MucousMembraneRoute', '_NailRoute', '_NasalRoute', '_OphthalmicRoute', '_OralRoute', '_OromucosalRoute', '_OropharyngealRoute', '_OticRoute', '_ParanasalSinusesRoute', '_ParenteralRoute', '_PerianalRoute', '_PeriarticularRoute', '_PeriduralRoute', '_PerinealRoute', '_PerineuralRoute', '_PeriodontalRoute', '_PulmonaryRoute', '_RectalRoute', '_RespiratoryTractRoute', '_RetrobulbarRoute', '_ScalpRoute', '_SinusUnspecifiedRoute', '_SkinRoute', '_SoftTissueRoute', '_SubarachnoidRoute', '_SubconjunctivalRoute', '_SubcutaneousRoute', '_SublesionalRoute', '_SublingualRoute', '_SubmucosalRoute', '_TracheostomyRoute', '_TransmucosalRoute', '_TransplacentalRoute', '_TranstrachealRoute', '_TranstympanicRoute', '_UreteralRoute', '_UrethralRoute', '_UrinaryBladderRoute', '_UrinaryTractRoute', '_VaginalRoute', '_VitreousHumourRoute']}, '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},
  '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, #each_element, #equals?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #to_reference, #valid?, #validate, #validate_profile

Constructor Details

This class inherits a constructor from FHIR::DSTU2::Model

Dynamic Method Handling

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

Instance Attribute Details

#contained ⇒ Object

0-* [ Resource ]



120
121
122
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 120

def contained
  @contained
end

#date ⇒ Object

0-1 dateTime



125
126
127
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 125

def date
  @date
end

#doseQuantity ⇒ Object

0-1 Quantity



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

def doseQuantity
  @doseQuantity
end

#encounter ⇒ Object

0-1 Reference()



132
133
134
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 132

def encounter
  @encounter
end

#expirationDate ⇒ Object

0-1 date



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

def expirationDate
  @expirationDate
end

#explanation ⇒ Object

0-1 Immunization::Explanation



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

def explanation
  @explanation
end

#extension ⇒ Object

0-* [ Extension ]



121
122
123
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 121

def extension
  @extension
end

#id ⇒ Object

0-1 id



115
116
117
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 115

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



123
124
125
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 123

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



117
118
119
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 117

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



118
119
120
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 118

def language
  @language
end

#location ⇒ Object

0-1 Reference()



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

def location
  @location
end

#lotNumber ⇒ Object

0-1 string



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

def lotNumber
  @lotNumber
end

#manufacturer ⇒ Object

0-1 Reference()



133
134
135
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 133

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



116
117
118
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 116

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



122
123
124
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 122

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



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

def note
  @note
end

#patient ⇒ Object

1-1 Reference()



127
128
129
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 127

def patient
  @patient
end

#performer ⇒ Object

0-1 Reference()



130
131
132
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 130

def performer
  @performer
end

#reaction ⇒ Object

0-* [ Immunization::Reaction ]



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

def reaction
  @reaction
end

#reported ⇒ Object

1-1 boolean



129
130
131
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 129

def reported
  @reported
end

#requester ⇒ Object

0-1 Reference()



131
132
133
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 131

def requester
  @requester
end

#route ⇒ Object

0-1 CodeableConcept



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

def route
  @route
end

#site ⇒ Object

0-1 CodeableConcept



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

def site
  @site
end

#status ⇒ Object

1-1 code



124
125
126
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 124

def status
  @status
end

#text ⇒ Object

0-1 Narrative



119
120
121
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 119

def text
  @text
end

#vaccinationProtocol ⇒ Object

0-* [ Immunization::VaccinationProtocol ]



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

def vaccinationProtocol
  @vaccinationProtocol
end

#vaccineCode ⇒ Object

1-1 CodeableConcept



126
127
128
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 126

def vaccineCode
  @vaccineCode
end

#wasNotGiven ⇒ Object

1-1 boolean



128
129
130
 
# File 'lib/fhir_dstu2_models/fhir/resources/Immunization.rb', line 128

def wasNotGiven
  @wasNotGiven
end

Instance Method Details

#resourceType ⇒ Object 



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

def resourceType
  'Immunization'
end