Class: FHIR::R5::MedicationAdministration

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

Defined Under Namespace

Classes: Dosage, Performer

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'occurence' => ['dateTime', 'Period', 'Timing']
}
SEARCH_PARAMS = 
['code', 'date', 'device', 'encounter', 'identifier', 'medication', 'patient', 'performer', 'performer-device-code', 'reason-given', 'reason-given-code', 'reason-not-given', 'request', 'status', 'subject']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'MedicationAdministration.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'MedicationAdministration.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'MedicationAdministration.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'MedicationAdministration.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'additional'=>[{'purpose'=>'starter', 'valueSet'=>'http://hl7.org/fhir/ValueSet/languages'}], 'uri'=>'http://hl7.org/fhir/ValueSet/all-languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'MedicationAdministration.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'MedicationAdministration.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'MedicationAdministration.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'MedicationAdministration.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'MedicationAdministration.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'basedOn' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CarePlan'], 'type'=>'Reference', 'path'=>'MedicationAdministration.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'partOf' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/MedicationAdministration', 'http://hl7.org/fhir/StructureDefinition/Procedure', 'http://hl7.org/fhir/StructureDefinition/MedicationDispense'], 'type'=>'Reference', 'path'=>'MedicationAdministration.partOf', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/CodeSystem/medication-admin-status'=>['in-progress', 'not-done', 'on-hold', 'completed', 'entered-in-error', 'stopped', 'unknown']}, 'type'=>'code', 'path'=>'MedicationAdministration.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/medication-admin-status'}},
  'statusReason' => {'valid_codes'=>{'http://snomed.info/sct'=>['242990004', '182895007', '182896008', '182897004', '182898009', '182899001', '182900006', '182901005', '182902003', '182903008']}, 'type'=>'CodeableConcept', 'path'=>'MedicationAdministration.statusReason', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes'}},
  'category' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/medication-admin-location'=>['inpatient', 'outpatient', 'community']}, 'type'=>'CodeableConcept', 'path'=>'MedicationAdministration.category', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/medication-admin-location'}},
  'medication' => {'type'=>'CodeableReference', 'path'=>'MedicationAdministration.medication', 'min'=>1, 'max'=>1},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'MedicationAdministration.subject', 'min'=>1, 'max'=>1},
  'encounter' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'MedicationAdministration.encounter', 'min'=>0, 'max'=>1},
  'supportingInformation' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'MedicationAdministration.supportingInformation', 'min'=>0, 'max'=>Float::INFINITY},
  'occurenceDateTime' => {'type'=>'dateTime', 'path'=>'MedicationAdministration.occurence[x]', 'min'=>1, 'max'=>1},
  'occurencePeriod' => {'type'=>'Period', 'path'=>'MedicationAdministration.occurence[x]', 'min'=>1, 'max'=>1},
  'occurenceTiming' => {'type'=>'Timing', 'path'=>'MedicationAdministration.occurence[x]', 'min'=>1, 'max'=>1},
  'recorded' => {'type'=>'dateTime', 'path'=>'MedicationAdministration.recorded', 'min'=>0, 'max'=>1},
  'isSubPotent' => {'type'=>'boolean', 'path'=>'MedicationAdministration.isSubPotent', 'min'=>0, 'max'=>1},
  'subPotentReason' => {'valid_codes'=>{'http://hl7.org/fhir/CodeSystem/administration-subpotent-reason'=>['partialdose', 'vomited', 'coldchainbreak', 'recall', 'adversestorage', 'expired']}, 'type'=>'CodeableConcept', 'path'=>'MedicationAdministration.subPotentReason', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/administration-subpotent-reason'}},
  'performer' => {'type'=>'MedicationAdministration::Performer', 'path'=>'MedicationAdministration.performer', 'min'=>0, 'max'=>Float::INFINITY},
  'reason' => {'type'=>'CodeableReference', 'path'=>'MedicationAdministration.reason', 'min'=>0, 'max'=>Float::INFINITY},
  'request' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/MedicationRequest'], 'type'=>'Reference', 'path'=>'MedicationAdministration.request', 'min'=>0, 'max'=>1},
  'device' => {'type'=>'CodeableReference', 'path'=>'MedicationAdministration.device', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'MedicationAdministration.note', 'min'=>0, 'max'=>Float::INFINITY},
  'dosage' => {'type'=>'MedicationAdministration::Dosage', 'path'=>'MedicationAdministration.dosage', 'min'=>0, 'max'=>1},
  'eventHistory' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Provenance'], 'type'=>'Reference', 'path'=>'MedicationAdministration.eventHistory', 'min'=>0, 'max'=>Float::INFINITY}
}

Constants included from FHIR::R4

FHIR::R4::PRIMITIVES, FHIR::R4::RESOURCES, FHIR::R4::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

Constants included from FHIR::R5

PRIMITIVES, RESOURCES, TYPES

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 included from FHIR::R5

#fhir_version_string, #versioned_fhir_module

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

#basedOn ⇒ Object

0-* [ Reference(CarePlan) ]



108
109
110
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 108

def basedOn
  @basedOn
end

#category ⇒ Object

0-* [ CodeableConcept ]



112
113
114
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 112

def category
  @category
end

#contained ⇒ Object

0-* [ Resource ]



104
105
106
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 104

def contained
  @contained
end

#device ⇒ Object

0-* [ CodeableReference ]



126
127
128
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 126

def device
  @device
end

#dosage ⇒ Object

0-1 MedicationAdministration::Dosage



128
129
130
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 128

def dosage
  @dosage
end

#encounter ⇒ Object

0-1 Reference(Encounter)



115
116
117
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 115

def encounter
  @encounter
end

#eventHistory ⇒ Object

0-* [ Reference(Provenance) ]



129
130
131
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 129

def eventHistory
  @eventHistory
end

#extension ⇒ Object

0-* [ Extension ]



105
106
107
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 105

def extension
  @extension
end

#id ⇒ Object

0-1 id



99
100
101
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 99

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



107
108
109
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 107

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



101
102
103
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 101

def implicitRules
  @implicitRules
end

#isSubPotent ⇒ Object

0-1 boolean



121
122
123
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 121

def isSubPotent
  @isSubPotent
end

#language ⇒ Object

0-1 code



102
103
104
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 102

def language
  @language
end

#medication ⇒ Object

1-1 CodeableReference



113
114
115
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 113

def medication
  @medication
end

#meta ⇒ Object

0-1 Meta



100
101
102
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 100

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



106
107
108
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 106

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



127
128
129
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 127

def note
  @note
end

#occurenceDateTime ⇒ Object

1-1 dateTime



117
118
119
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 117

def occurenceDateTime
  @occurenceDateTime
end

#occurencePeriod ⇒ Object

1-1 Period



118
119
120
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 118

def occurencePeriod
  @occurencePeriod
end

#occurenceTiming ⇒ Object

1-1 Timing



119
120
121
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 119

def occurenceTiming
  @occurenceTiming
end

#partOf ⇒ Object

0-* [ Reference(MedicationAdministration|Procedure|MedicationDispense) ]



109
110
111
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 109

def partOf
  @partOf
end

#performer ⇒ Object

0-* [ MedicationAdministration::Performer ]



123
124
125
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 123

def performer
  @performer
end

#reason ⇒ Object

0-* [ CodeableReference ]



124
125
126
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 124

def reason
  @reason
end

#recorded ⇒ Object

0-1 dateTime



120
121
122
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 120

def recorded
  @recorded
end

#request ⇒ Object

0-1 Reference(MedicationRequest)



125
126
127
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 125

def request
  @request
end

#status ⇒ Object

1-1 code



110
111
112
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 110

def status
  @status
end

#statusReason ⇒ Object

0-* [ CodeableConcept ]



111
112
113
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 111

def statusReason
  @statusReason
end

#subject ⇒ Object

1-1 Reference(Patient|Group)



114
115
116
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 114

def subject
  @subject
end

#subPotentReason ⇒ Object

0-* [ CodeableConcept ]



122
123
124
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 122

def subPotentReason
  @subPotentReason
end

#supportingInformation ⇒ Object

0-* [ Reference(Resource) ]



116
117
118
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 116

def supportingInformation
  @supportingInformation
end

#text ⇒ Object

0-1 Narrative



103
104
105
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 103

def text
  @text
end

Instance Method Details

#resourceType ⇒ Object 



131
132
133
 
# File 'lib/fhir_models/r5/generated/resources/MedicationAdministration.rb', line 131

def resourceType
  'MedicationAdministration'
end