Class: FHIR::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/fhir_models/bootstrap/model.rb

Direct Known Subclasses

Account, ActivityDefinition, ActivityDefinition::DynamicValue, Address, Age, AllergyIntolerance, AllergyIntolerance::Reaction, Annotation, Appointment, Appointment::Participant, AppointmentResponse, Attachment, AuditEvent, AuditEvent::Agent, AuditEvent::Agent::Network, AuditEvent::Entity, AuditEvent::Entity::Detail, AuditEvent::Source, BackboneElement, Basic, Binary, BodySite, Bundle, Bundle::Entry, Bundle::Entry::Request, Bundle::Entry::Response, Bundle::Entry::Search, Bundle::Link, CapabilityStatement, CapabilityStatement::Contact, CapabilityStatement::Document, CapabilityStatement::Implementation, CapabilityStatement::Messaging, CapabilityStatement::Messaging::Endpoint, CapabilityStatement::Messaging::Event, CapabilityStatement::Rest, CapabilityStatement::Rest::Interaction, CapabilityStatement::Rest::Operation, CapabilityStatement::Rest::Resource, CapabilityStatement::Rest::Resource::Interaction, CapabilityStatement::Rest::Resource::SearchParam, CapabilityStatement::Rest::Security, CapabilityStatement::Rest::Security::Certificate, CapabilityStatement::Software, CarePlan, CarePlan::Activity, CarePlan::Activity::Detail, CarePlan::RelatedPlan, CareTeam, CareTeam::Participant, Claim, Claim::Accident, Claim::Coverage, Claim::Diagnosis, Claim::Information, Claim::Item, Claim::Item::CareTeam, Claim::Item::Detail, Claim::Item::Detail::SubDetail, Claim::Item::Prosthesis, Claim::MissingTeeth, Claim::Payee, Claim::Procedure, Claim::Related, ClaimResponse, ClaimResponse::AddItem, ClaimResponse::AddItem::Detail, ClaimResponse::Coverage, ClaimResponse::Error, ClaimResponse::Item, ClaimResponse::Item::Adjudication, ClaimResponse::Item::Detail, ClaimResponse::Item::Detail::SubDetail, ClaimResponse::Note, ClaimResponse::Payment, ClinicalImpression, ClinicalImpression::Finding, ClinicalImpression::Investigations, CodeSystem, CodeSystem::Concept, CodeSystem::Concept::Designation, CodeSystem::Concept::Property, CodeSystem::Contact, CodeSystem::Filter, CodeSystem::Property, CodeableConcept, Coding, Communication, Communication::Payload, CommunicationRequest, CommunicationRequest::Payload, CompartmentDefinition, CompartmentDefinition::Contact, CompartmentDefinition::Resource, Composition, Composition::Attester, Composition::Event, Composition::Section, ConceptMap, ConceptMap::Contact, ConceptMap::Group, ConceptMap::Group::Element, ConceptMap::Group::Element::Target, ConceptMap::Group::Element::Target::DependsOn, Condition, Condition::Evidence, Condition::Stage, Conformance, Conformance::Contact, Conformance::Document, Conformance::Implementation, Conformance::Messaging, Conformance::Messaging::Endpoint, Conformance::Messaging::Event, Conformance::Rest, Conformance::Rest::Interaction, Conformance::Rest::Operation, Conformance::Rest::Resource, Conformance::Rest::Resource::Interaction, Conformance::Rest::Resource::SearchParam, Conformance::Rest::Security, Conformance::Rest::Security::Certificate, Conformance::Software, Consent, Consent::Except, Consent::Except::Actor, Consent::Except::Data, ContactDetail, ContactPoint, Contract, Contract::Agent, Contract::Friendly, Contract::Legal, Contract::Rule, Contract::Signer, Contract::Term, Contract::Term::Agent, Contract::Term::ValuedItem, Contract::ValuedItem, Contributor, Count, Coverage, DataElement, DataElement::Contact, DataElement::Mapping, DataRequirement, DataRequirement::CodeFilter, DataRequirement::DateFilter, DecisionSupportServiceModule, DetectedIssue, DetectedIssue::Mitigation, Device, DeviceComponent, DeviceComponent::ProductionSpecification, DeviceMetric, DeviceMetric::Calibration, DeviceUseRequest, DeviceUseStatement, DiagnosticReport, DiagnosticReport::Image, DiagnosticRequest, Distance, DocumentManifest, DocumentManifest::Content, DocumentManifest::Related, DocumentReference, DocumentReference::Content, DocumentReference::Context, DocumentReference::Context::Related, DocumentReference::RelatesTo, DomainResource, Duration, Element, ElementDefinition, ElementDefinition::Base, ElementDefinition::Binding, ElementDefinition::Constraint, ElementDefinition::Mapping, ElementDefinition::Slicing, ElementDefinition::Type, EligibilityRequest, EligibilityResponse, EligibilityResponse::BenefitBalance, EligibilityResponse::BenefitBalance::Financial, EligibilityResponse::Error, Encounter, Encounter::Hospitalization, Encounter::Location, Encounter::Participant, Encounter::StatusHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EpisodeOfCare::StatusHistory, ExpansionProfile, ExpansionProfile::CodeSystem, ExpansionProfile::CodeSystem::Exclude, ExpansionProfile::CodeSystem::Exclude::CodeSystem, ExpansionProfile::CodeSystem::Include, ExpansionProfile::CodeSystem::Include::CodeSystem, ExpansionProfile::Contact, ExpansionProfile::Designation, ExpansionProfile::Designation::Exclude, ExpansionProfile::Designation::Exclude::Designation, ExpansionProfile::Designation::Include, ExpansionProfile::Designation::Include::Designation, ExplanationOfBenefit, ExplanationOfBenefit::Accident, ExplanationOfBenefit::AddItem, ExplanationOfBenefit::AddItem::Detail, ExplanationOfBenefit::BenefitBalance, ExplanationOfBenefit::BenefitBalance::Financial, ExplanationOfBenefit::Coverage, ExplanationOfBenefit::Diagnosis, ExplanationOfBenefit::Information, ExplanationOfBenefit::Item, ExplanationOfBenefit::Item::Adjudication, ExplanationOfBenefit::Item::CareTeam, ExplanationOfBenefit::Item::Detail, ExplanationOfBenefit::Item::Detail::SubDetail, ExplanationOfBenefit::Item::Prosthesis, ExplanationOfBenefit::MissingTeeth, ExplanationOfBenefit::Note, ExplanationOfBenefit::Payee, ExplanationOfBenefit::Payment, ExplanationOfBenefit::Procedure, ExplanationOfBenefit::Related, Extension, FamilyMemberHistory, FamilyMemberHistory::Condition, Flag, Goal, Goal::Outcome, Group, Group::Characteristic, Group::Member, GuidanceResponse, GuidanceResponse::Action, GuidanceResponse::Action::RelatedAction, HealthcareService, HealthcareService::AvailableTime, HealthcareService::NotAvailable, HumanName, Identifier, ImagingManifest, ImagingManifest::Study, ImagingManifest::Study::BaseLocation, ImagingManifest::Study::Series, ImagingManifest::Study::Series::BaseLocation, ImagingManifest::Study::Series::Instance, ImagingStudy, ImagingStudy::BaseLocation, ImagingStudy::Series, ImagingStudy::Series::BaseLocation, ImagingStudy::Series::Instance, Immunization, Immunization::Explanation, Immunization::Reaction, Immunization::VaccinationProtocol, ImmunizationRecommendation, ImmunizationRecommendation::Recommendation, ImmunizationRecommendation::Recommendation::DateCriterion, ImmunizationRecommendation::Recommendation::Protocol, ImplementationGuide, ImplementationGuide::Contact, ImplementationGuide::Dependency, ImplementationGuide::Global, ImplementationGuide::Package, ImplementationGuide::Package::Resource, ImplementationGuide::Page, Library, Linkage, Linkage::Item, List, List::Entry, Location, Location::Position, Measure, FHIR::Measure::Group, FHIR::Measure::Group::Population, FHIR::Measure::Group::Stratifier, FHIR::Measure::SupplementalData, MeasureReport, FHIR::MeasureReport::Group, FHIR::MeasureReport::Group::Population, FHIR::MeasureReport::Group::Stratifier, FHIR::MeasureReport::Group::Stratifier::Group, FHIR::MeasureReport::Group::Stratifier::Group::Population, FHIR::MeasureReport::Group::SupplementalData, FHIR::MeasureReport::Group::SupplementalData::Group, Media, Medication, FHIR::Medication::Package, FHIR::Medication::Package::Content, FHIR::Medication::Product, FHIR::Medication::Product::Batch, FHIR::Medication::Product::Ingredient, MedicationAdministration, FHIR::MedicationAdministration::Dosage, FHIR::MedicationAdministration::EventHistory, MedicationDispense, FHIR::MedicationDispense::DosageInstruction, FHIR::MedicationDispense::EventHistory, FHIR::MedicationDispense::Substitution, MedicationOrder, FHIR::MedicationOrder::DispenseRequest, FHIR::MedicationOrder::DosageInstruction, FHIR::MedicationOrder::EventHistory, FHIR::MedicationOrder::Substitution, MedicationStatement, FHIR::MedicationStatement::Dosage, MessageHeader, FHIR::MessageHeader::Destination, FHIR::MessageHeader::Response, FHIR::MessageHeader::Source, Meta, Money, NamingSystem, NamingSystem::Contact, NamingSystem::UniqueId, Narrative, NutritionRequest, NutritionRequest::EnteralFormula, NutritionRequest::EnteralFormula::Administration, NutritionRequest::OralDiet, NutritionRequest::OralDiet::Nutrient, NutritionRequest::OralDiet::Texture, NutritionRequest::Supplement, Observation, Observation::Component, Observation::ReferenceRange, Observation::Related, OperationDefinition, OperationDefinition::Contact, OperationDefinition::Parameter, OperationDefinition::Parameter::Binding, OperationOutcome, OperationOutcome::Issue, Organization, Organization::Contact, ParameterDefinition, Parameters, Parameters::Parameter, Patient, Patient::Animal, Patient::Communication, Patient::Contact, Patient::Link, PaymentNotice, PaymentReconciliation, PaymentReconciliation::Detail, PaymentReconciliation::Note, Period, Person, Person::Link, PlanDefinition, PlanDefinition::ActionDefinition, PlanDefinition::ActionDefinition::Condition, PlanDefinition::ActionDefinition::DynamicValue, PlanDefinition::ActionDefinition::RelatedAction, Practitioner, Practitioner::Qualification, Practitioner::Role, PractitionerRole, PractitionerRole::AvailableTime, PractitionerRole::NotAvailable, Procedure, Procedure::FocalDevice, Procedure::Performer, ProcedureRequest, ProcessRequest, ProcessRequest::Item, ProcessResponse, ProcessResponse::Notes, Provenance, Provenance::Agent, Provenance::Agent::RelatedAgent, Provenance::Entity, Quantity, Questionnaire, Questionnaire::Item, Questionnaire::Item::EnableWhen, Questionnaire::Item::Option, QuestionnaireResponse, QuestionnaireResponse::Item, QuestionnaireResponse::Item::Answer, Range, Ratio, Reference, ReferralRequest, RelatedPerson, RelatedResource, Resource, RiskAssessment, RiskAssessment::Prediction, SampledData, Schedule, SearchParameter, SearchParameter::Contact, Sequence, Sequence::Quality, Sequence::ReferenceSeq, Sequence::Repository, Sequence::StructureVariant, Sequence::StructureVariant::Inner, Sequence::StructureVariant::Outer, Sequence::Variant, Signature, Slot, Specimen, Specimen::Collection, Specimen::Container, Specimen::Treatment, StructureDefinition, StructureDefinition::Contact, StructureDefinition::Differential, StructureDefinition::Mapping, StructureDefinition::Snapshot, StructureMap, StructureMap::Contact, StructureMap::Group, StructureMap::Group::Input, StructureMap::Group::Rule, StructureMap::Group::Rule::Dependent, StructureMap::Group::Rule::Source, StructureMap::Group::Rule::Target, StructureMap::Group::Rule::Target::Parameter, StructureMap::Structure, Subscription, Subscription::Channel, Substance, Substance::Ingredient, Substance::Instance, SupplyDelivery, SupplyRequest, SupplyRequest::When, Task, Task::Fulfillment, Task::Input, Task::Output, TestScript, TestScript::Contact, TestScript::Destination, TestScript::Fixture, TestScript::Metadata, TestScript::Metadata::Capability, TestScript::Metadata::Link, TestScript::Origin, TestScript::Rule, TestScript::Rule::Param, TestScript::Ruleset, TestScript::Ruleset::Rule, TestScript::Ruleset::Rule::Param, TestScript::Setup, TestScript::Setup::Action, TestScript::Setup::Action::Assert, TestScript::Setup::Action::Assert::Rule, TestScript::Setup::Action::Assert::Rule::Param, TestScript::Setup::Action::Assert::Ruleset, TestScript::Setup::Action::Assert::Ruleset::Rule, TestScript::Setup::Action::Assert::Ruleset::Rule::Param, TestScript::Setup::Action::Operation, TestScript::Setup::Action::Operation::RequestHeader, TestScript::Teardown, TestScript::Teardown::Action, TestScript::Test, TestScript::Test::Action, TestScript::Variable, Timing, Timing::Repeat, TriggerDefinition, UsageContext, ValueSet, ValueSet::Compose, ValueSet::Compose::Include, ValueSet::Compose::Include::Concept, ValueSet::Compose::Include::Concept::Designation, ValueSet::Compose::Include::Filter, ValueSet::Contact, ValueSet::Expansion, ValueSet::Expansion::Contains, ValueSet::Expansion::Parameter, VisionPrescription, VisionPrescription::Dispense

Instance Method Summary collapse

Constructor Details

#initialize(hash = {}) ⇒ Model

Returns a new instance of Model.



9
10
11
12
13
14
15
16
# File 'lib/fhir_models/bootstrap/model.rb', line 9

def initialize(hash={})
  self.from_hash(hash)
  self.class::METADATA.each do |key, value|
    if value['max'] > 1 && self.instance_variable_get("@#{key}").nil?
      self.instance_variable_set("@#{key}".to_sym, [])
    end
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object



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
# File 'lib/fhir_models/bootstrap/model.rb', line 18

def method_missing(method, *args, &block)
  if defined?(self.class::MULTIPLE_TYPES) && self.class::MULTIPLE_TYPES[method.to_s]
    self.class::MULTIPLE_TYPES[method.to_s].each do |type|
      type[0] = type[0].upcase
      value = self.method("#{method}#{type}").call()
      return value if !value.nil?
    end
    return nil
  elsif (!@extension.nil? && !@extension.empty?)
    ext = @extension.select do |x|
      name = x.url.tr('-', '_').split('/').last
      anchor = name.split('#').last
      (method.to_s==name || method.to_s==anchor)
    end
    if !ext.first.nil?
      if !ext.first.value.nil?
        return ext.first.value
      else
        return ext.first
      end
    end
  elsif (!@modifierExtension.nil? && !@modifierExtension.empty?)
    ext = @modifierExtension.select do |x|
      name = x.url.tr('-', '_').split('/').last
      anchor = name.split('#').last
      (method.to_s==name || method.to_s==anchor)
    end
    if !ext.first.nil?
      if !ext.first.value.nil?
        return ext.first.value
      else
        return ext.first
      end
    end
  end
  super(method, *args, &block)
end

Instance Method Details

#attribute_mismatch(left, right, exclude = []) ⇒ Object



79
80
81
82
83
84
85
# File 'lib/fhir_models/bootstrap/model.rb', line 79

def attribute_mismatch(left, right, exclude=[])
  if left.respond_to?(:mismatch) && right.respond_to?(:mismatch)
    left.mismatch right, exclude
  else
    compare_attribute(left, right, exclude)
  end
end

#compare_attribute(left, right, exclude = []) ⇒ Object



87
88
89
90
91
92
93
94
95
96
97
# File 'lib/fhir_models/bootstrap/model.rb', line 87

def compare_attribute(left, right, exclude=[])
  if left.respond_to?(:equals?) && right.respond_to?(:equals?)
    left.equals? right, exclude
  elsif left.is_a?(Array) && right.is_a?(Array) && (left.length == right.length)
    result = true
    (0...(left.length)).each {|i| result &&= compare_attribute(left[i], right[i], exclude)}
    result
  else
    left == right
  end
end

#equals?(other, exclude = []) ⇒ Boolean

Returns:

  • (Boolean)


60
61
62
63
64
65
# File 'lib/fhir_models/bootstrap/model.rb', line 60

def equals?(other, exclude=[])
  (self.class::METADATA.keys - exclude).each do |attribute|
    return false unless compare_attribute(self.instance_variable_get("@#{attribute}".to_sym), other.instance_variable_get("@#{attribute}".to_sym), exclude)
  end
  true
end

#is_valid?Boolean

Returns:

  • (Boolean)


99
100
101
# File 'lib/fhir_models/bootstrap/model.rb', line 99

def is_valid?
  validate.empty?
end

#mismatch(other, exclude = []) ⇒ Object



67
68
69
70
71
72
73
74
75
76
77
# File 'lib/fhir_models/bootstrap/model.rb', line 67

def mismatch(other, exclude=[])
  misses = []
  (self.class::METADATA.keys - exclude).each do |key|
    these = attribute_mismatch(self.instance_variable_get("@#{key}".to_sym), other.instance_variable_get("@#{key}".to_sym), exclude)
    if !these || (these.is_a?(Array) && !these.empty?)
      misses << "#{self.class}::#{key}"
      misses.concat these if these.is_a?(Array)
    end
  end
  misses
end

#to_referenceObject



56
57
58
# File 'lib/fhir_models/bootstrap/model.rb', line 56

def to_reference
  FHIR::Reference.new(reference: "#{self.class.name.split('::').last}/#{self.id}")
end

#validate(contained = nil) ⇒ Object



103
104
105
# File 'lib/fhir_models/bootstrap/model.rb', line 103

def validate(contained=nil)
  validate_profile(self.class::METADATA, contained)
end

#validate_profile(metadata, contained = nil) ⇒ Object



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/fhir_models/bootstrap/model.rb', line 107

def validate_profile(, contained=nil)
  contained_here = [ self.instance_variable_get('@contained'.to_sym) ].flatten
  contained_here << contained
  contained_here = contained_here.flatten.compact
  errors = {}
  .each do |field, meta|
    if meta.is_a?(Array)
      # this field has been 'sliced'
      meta.each do |slice|
        local_name = slice['local_name'] || field
        value = [ self.instance_variable_get("@#{local_name}".to_sym) ].flatten.compact
        subset = [] # subset is the values associated with just this slice
        if slice['type']=='Extension'
          if slice['type_profiles']
            subset = value.select{|x|slice['type_profiles'].include?(x.url)}
          else
            subset = value
          end
        else
          FHIR.logger.warn 'Validation not supported on slices (except for Extensions)'
        end
        validate_field(field, subset, contained_here, slice, errors)
      end
    else
      local_name = meta['local_name'] || field
      value = [ self.instance_variable_get("@#{local_name}".to_sym) ].flatten.compact
      validate_field(field, value, contained_here, meta, errors)
    end
  end # metadata.each
  # check multiple types
  multiple_types = self.class::MULTIPLE_TYPES rescue {}
  multiple_types.each do |prefix, suffixes|
    count = 0
    present = []
    suffixes.each do |suffix|
      typename = "#{prefix}#{suffix[0].upcase}#{suffix[1..-1]}"
      count += 1 if errors[typename]
      # check which multiple data types are actually present, not just errors
      # actually, this might be allowed depending on cardinality
      value = self.instance_variable_get("@#{typename}")
      present << typename if !value.nil? || (value.is_a?(Array) && !value.empty?)
    end
    errors[prefix] = ["#{prefix}[x]: more than one type present."] if(count > 1)
    # remove errors for suffixes that are not present
    suffixes.each do |suffix|
      typename = "#{prefix}#{suffix[0].upcase}#{suffix[1..-1]}"
      errors.delete(typename) if !present.include?(typename)
    end
  end
  errors.keep_if{|_k, v|(v && !v.empty?)}
end