Class: FHIR::Immunization

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

Defined Under Namespace

Classes: Explanation, Reaction, VaccinationProtocol

Constant Summary collapse

SEARCH_PARAMS = 
["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'=>'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'=>['in-progress', 'on-hold', 'completed', 'entered-in-error', 'stopped', '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' => {'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},
  'wasNotGiven' => {'type'=>'boolean', 'path'=>'Immunization.wasNotGiven', 'min'=>1, 'max'=>1},
  'reported' => {'type'=>'boolean', 'path'=>'Immunization.reported', 'min'=>1, 'max'=>1},
  'performer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner'], 'type'=>'Reference', 'path'=>'Immunization.performer', 'min'=>0, 'max'=>1},
  'requester' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner'], 'type'=>'Reference', 'path'=>'Immunization.requester', 'min'=>0, 'max'=>1},
  'encounter' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'Immunization.encounter', 'min'=>0, 'max'=>1},
  'manufacturer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'Immunization.manufacturer', 'min'=>0, 'max'=>1},
  'location' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/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'=>['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},
  '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, is_valid?, #to_xml, validate

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?, #initialize, #is_valid?, #method_missing, #mismatch, #to_reference, #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 ]



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

def contained
  @contained
end

#date ⇒ Object

0-1 dateTime



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

def date
  @date
end

#doseQuantity ⇒ Object

0-1 Quantity



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

def doseQuantity
  @doseQuantity
end

#encounter ⇒ Object

0-1 Reference(Encounter)



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

def encounter
  @encounter
end

#expirationDate ⇒ Object

0-1 date



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

def expirationDate
  @expirationDate
end

#explanation ⇒ Object

0-1 Immunization::Explanation



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

def explanation
  @explanation
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#id ⇒ Object

0-1 id



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

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#location ⇒ Object

0-1 Reference(Location)



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

def location
  @location
end

#lotNumber ⇒ Object

0-1 string



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

def lotNumber
  @lotNumber
end

#manufacturer ⇒ Object

0-1 Reference(Organization)



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

def manufacturer
  @manufacturer
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



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

def note
  @note
end

#patient ⇒ Object

1-1 Reference(Patient)



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

def patient
  @patient
end

#performer ⇒ Object

0-1 Reference(Practitioner)



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

def performer
  @performer
end

#reaction ⇒ Object

0-* [ Immunization::Reaction ]



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

def reaction
  @reaction
end

#reported ⇒ Object

1-1 boolean



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

def reported
  @reported
end

#requester ⇒ Object

0-1 Reference(Practitioner)



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

def requester
  @requester
end

#route ⇒ Object

0-1 CodeableConcept



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

def route
  @route
end

#site ⇒ Object

0-1 CodeableConcept



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

def site
  @site
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#vaccinationProtocol ⇒ Object

0-* [ Immunization::VaccinationProtocol ]



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

def vaccinationProtocol
  @vaccinationProtocol
end

#vaccineCode ⇒ Object

1-1 CodeableConcept



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

def vaccineCode
  @vaccineCode
end

#wasNotGiven ⇒ Object

1-1 boolean



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

def wasNotGiven
  @wasNotGiven
end

Instance Method Details

#resourceType ⇒ Object 



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

def resourceType
  'Immunization'
end