Class: FHIR::STU3::Model

Inherits:
Object
  • Object
show all
Extended by:
Deprecate
Defined in:
lib/fhir_stu3_models/bootstrap/model.rb

Direct Known Subclasses

Account, Account::Coverage, Account::Guarantor, ActivityDefinition, ActivityDefinition::DynamicValue, ActivityDefinition::Participant, Address, AdverseEvent, AdverseEvent::SuspectEntity, AdverseEvent::SuspectEntity::Causality, 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::Document, CapabilityStatement::Implementation, CapabilityStatement::Messaging, CapabilityStatement::Messaging::Endpoint, CapabilityStatement::Messaging::Event, CapabilityStatement::Messaging::SupportedMessage, 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, CareTeam, CareTeam::Participant, ChargeItem, ChargeItem::Participant, Claim, Claim::Accident, Claim::CareTeam, Claim::Diagnosis, Claim::Information, Claim::Insurance, Claim::Item, Claim::Item::Detail, Claim::Item::Detail::SubDetail, Claim::Payee, Claim::Procedure, Claim::Related, ClaimResponse, ClaimResponse::AddItem, ClaimResponse::AddItem::Detail, ClaimResponse::Error, ClaimResponse::Insurance, ClaimResponse::Item, ClaimResponse::Item::Adjudication, ClaimResponse::Item::Detail, ClaimResponse::Item::Detail::SubDetail, ClaimResponse::Payment, ClaimResponse::ProcessNote, ClinicalImpression, ClinicalImpression::Finding, ClinicalImpression::Investigation, CodeSystem, CodeSystem::Concept, CodeSystem::Concept::Designation, CodeSystem::Concept::Property, CodeSystem::Filter, CodeSystem::Property, CodeableConcept, Coding, Communication, Communication::Payload, CommunicationRequest, CommunicationRequest::Payload, CommunicationRequest::Requester, CompartmentDefinition, CompartmentDefinition::Resource, Composition, Composition::Attester, Composition::Event, Composition::RelatesTo, Composition::Section, ConceptMap, ConceptMap::Group, ConceptMap::Group::Element, ConceptMap::Group::Element::Target, ConceptMap::Group::Element::Target::DependsOn, ConceptMap::Group::Unmapped, Condition, Condition::Evidence, Condition::Stage, Consent, Consent::Actor, Consent::Data, Consent::Except, Consent::Except::Actor, Consent::Except::Data, Consent::Policy, 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, Coverage::Grouping, DataElement, DataElement::Mapping, DataRequirement, DataRequirement::CodeFilter, DataRequirement::DateFilter, DetectedIssue, DetectedIssue::Mitigation, Device, Device::Udi, DeviceComponent, DeviceComponent::ProductionSpecification, DeviceMetric, DeviceMetric::Calibration, DeviceRequest, DeviceRequest::Requester, DeviceUseStatement, DiagnosticReport, DiagnosticReport::Image, DiagnosticReport::Performer, Distance, DocumentManifest, DocumentManifest::Content, DocumentManifest::Related, DocumentReference, DocumentReference::Content, DocumentReference::Context, DocumentReference::Context::Related, DocumentReference::RelatesTo, DomainResource, Dosage, Duration, Element, ElementDefinition, ElementDefinition::Base, ElementDefinition::Binding, ElementDefinition::Constraint, ElementDefinition::Example, ElementDefinition::Mapping, ElementDefinition::Slicing, ElementDefinition::Slicing::Discriminator, ElementDefinition::Type, EligibilityRequest, EligibilityResponse, EligibilityResponse::Error, EligibilityResponse::Insurance, EligibilityResponse::Insurance::BenefitBalance, EligibilityResponse::Insurance::BenefitBalance::Financial, Encounter, Encounter::ClassHistory, Encounter::Diagnosis, Encounter::Hospitalization, Encounter::Location, Encounter::Participant, Encounter::StatusHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EpisodeOfCare::Diagnosis, EpisodeOfCare::StatusHistory, ExpansionProfile, ExpansionProfile::Designation, ExpansionProfile::Designation::Exclude, ExpansionProfile::Designation::Exclude::Designation, ExpansionProfile::Designation::Include, ExpansionProfile::Designation::Include::Designation, ExpansionProfile::ExcludedSystem, ExpansionProfile::FixedVersion, ExplanationOfBenefit, ExplanationOfBenefit::Accident, ExplanationOfBenefit::AddItem, ExplanationOfBenefit::AddItem::Detail, ExplanationOfBenefit::BenefitBalance, ExplanationOfBenefit::BenefitBalance::Financial, ExplanationOfBenefit::CareTeam, ExplanationOfBenefit::Diagnosis, ExplanationOfBenefit::Information, ExplanationOfBenefit::Insurance, ExplanationOfBenefit::Item, ExplanationOfBenefit::Item::Adjudication, ExplanationOfBenefit::Item::Detail, ExplanationOfBenefit::Item::Detail::SubDetail, ExplanationOfBenefit::Payee, ExplanationOfBenefit::Payment, ExplanationOfBenefit::Procedure, ExplanationOfBenefit::ProcessNote, ExplanationOfBenefit::Related, Extension, FamilyMemberHistory, FamilyMemberHistory::Condition, Flag, Goal, Goal::Target, GraphDefinition, GraphDefinition::Link, GraphDefinition::Link::Target, GraphDefinition::Link::Target::Compartment, Group, Group::Characteristic, Group::Member, GuidanceResponse, HealthcareService, HealthcareService::AvailableTime, HealthcareService::NotAvailable, HumanName, Identifier, ImagingManifest, ImagingManifest::Study, ImagingManifest::Study::Series, ImagingManifest::Study::Series::Instance, ImagingStudy, ImagingStudy::Series, ImagingStudy::Series::Instance, Immunization, Immunization::Explanation, Immunization::Practitioner, Immunization::Reaction, Immunization::VaccinationProtocol, ImmunizationRecommendation, ImmunizationRecommendation::Recommendation, ImmunizationRecommendation::Recommendation::DateCriterion, ImmunizationRecommendation::Recommendation::Protocol, ImplementationGuide, ImplementationGuide::Dependency, ImplementationGuide::Global, ImplementationGuide::Package, ImplementationGuide::Package::Resource, ImplementationGuide::Page, Library, Linkage, Linkage::Item, List, List::Entry, Location, Location::Position, Measure, FHIR::STU3::Measure::Group, FHIR::STU3::Measure::Group::Population, FHIR::STU3::Measure::Group::Stratifier, FHIR::STU3::Measure::SupplementalData, MeasureReport, FHIR::STU3::MeasureReport::Group, FHIR::STU3::MeasureReport::Group::Population, FHIR::STU3::MeasureReport::Group::Stratifier, FHIR::STU3::MeasureReport::Group::Stratifier::Stratum, FHIR::STU3::MeasureReport::Group::Stratifier::Stratum::Population, Media, Medication, FHIR::STU3::Medication::Ingredient, FHIR::STU3::Medication::Package, FHIR::STU3::Medication::Package::Batch, FHIR::STU3::Medication::Package::Content, MedicationAdministration, FHIR::STU3::MedicationAdministration::Dosage, FHIR::STU3::MedicationAdministration::Performer, MedicationDispense, FHIR::STU3::MedicationDispense::Performer, FHIR::STU3::MedicationDispense::Substitution, MedicationRequest, FHIR::STU3::MedicationRequest::DispenseRequest, FHIR::STU3::MedicationRequest::Requester, FHIR::STU3::MedicationRequest::Substitution, MedicationStatement, MessageDefinition, FHIR::STU3::MessageDefinition::AllowedResponse, FHIR::STU3::MessageDefinition::Focus, MessageHeader, FHIR::STU3::MessageHeader::Destination, FHIR::STU3::MessageHeader::Response, FHIR::STU3::MessageHeader::Source, Meta, Money, NamingSystem, NamingSystem::UniqueId, Narrative, NutritionOrder, NutritionOrder::EnteralFormula, NutritionOrder::EnteralFormula::Administration, NutritionOrder::OralDiet, NutritionOrder::OralDiet::Nutrient, NutritionOrder::OralDiet::Texture, NutritionOrder::Supplement, Observation, Observation::Component, Observation::ReferenceRange, Observation::Related, OperationDefinition, OperationDefinition::Overload, 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::ProcessNote, Period, Person, Person::Link, PlanDefinition, PlanDefinition::Action, PlanDefinition::Action::Condition, PlanDefinition::Action::DynamicValue, PlanDefinition::Action::Participant, PlanDefinition::Action::RelatedAction, PlanDefinition::Goal, PlanDefinition::Goal::Target, Practitioner, Practitioner::Qualification, PractitionerRole, PractitionerRole::AvailableTime, PractitionerRole::NotAvailable, Procedure, Procedure::FocalDevice, Procedure::Performer, ProcedureRequest, ProcedureRequest::Requester, ProcessRequest, ProcessRequest::Item, ProcessResponse, ProcessResponse::ProcessNote, Provenance, Provenance::Agent, Provenance::Entity, Quantity, Questionnaire, Questionnaire::Item, Questionnaire::Item::EnableWhen, Questionnaire::Item::Option, QuestionnaireResponse, QuestionnaireResponse::Item, QuestionnaireResponse::Item::Answer, Range, Ratio, Reference, ReferralRequest, ReferralRequest::Requester, RelatedArtifact, RelatedPerson, RequestGroup, RequestGroup::Action, RequestGroup::Action::Condition, RequestGroup::Action::RelatedAction, ResearchStudy, ResearchStudy::Arm, ResearchSubject, Resource, RiskAssessment, RiskAssessment::Prediction, SampledData, Schedule, SearchParameter, SearchParameter::Component, Sequence, Sequence::Quality, Sequence::ReferenceSeq, Sequence::Repository, Sequence::Variant, ServiceDefinition, Signature, Slot, Specimen, Specimen::Collection, Specimen::Container, Specimen::Processing, StructureDefinition, StructureDefinition::Differential, StructureDefinition::Mapping, StructureDefinition::Snapshot, StructureMap, 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, SupplyDelivery::SuppliedItem, SupplyRequest, SupplyRequest::OrderedItem, SupplyRequest::Requester, Task, Task::Input, Task::Output, Task::Requester, Task::Restriction, TestReport, TestReport::Participant, TestReport::Setup, TestReport::Setup::Action, TestReport::Setup::Action::Assert, TestReport::Setup::Action::Operation, TestReport::Teardown, TestReport::Teardown::Action, TestReport::Test, TestReport::Test::Action, TestScript, 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::Expansion, ValueSet::Expansion::Contains, ValueSet::Expansion::Parameter, VisionPrescription, VisionPrescription::Dispense

Instance Method Summary collapse

Methods included from Deprecate

deprecate

Constructor Details

#initialize(hash = {}) ⇒ Model

Returns a new instance of Model.



10
11
12
13
14
15
16
17
18
19
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 10

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *_args, &_block) ⇒ Object

Raises:

  • (NoMethodError)


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

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 = send("#{method}#{type}".to_sym)
      return value unless 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
    unless ext.first.nil?
      return ext.first.value.nil? ? ext.first : ext.first.value
    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
    unless ext.first.nil?
      return ext.first.value.nil? ? ext.first : ext.first.value
    end
  end
  raise NoMethodError.new("undefined method `#{method}' for #{inspect}", method)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

allow two FHIR models to be compared for equality



27
28
29
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 27

def ==(other)
  self.class == other.class && to_hash == other.to_hash
end

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



85
86
87
88
89
90
91
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 85

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



93
94
95
96
97
98
99
100
101
102
103
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 93

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

#each_element(path = nil, &block) ⇒ Object



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 297

def each_element(path = nil, &block)
  self.class::METADATA.each do |element_name, |
    local_name = .fetch :local_name, element_name
    values = [instance_variable_get("@#{local_name}")].flatten.compact
    next if values.empty?

    values.each_with_index do |value, i|
      child_path =
        if path.nil?
          element_name
        else
          "#{path}.#{element_name}"
        end
      child_path += "[#{i}]" if ['max'] > 1
      yield value, , child_path
      value.each_element child_path, &block unless FHIR::STU3::PRIMITIVES.include? ['type']
    end
  end
  self
end

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

Returns:

  • (Boolean)


66
67
68
69
70
71
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 66

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

#hashObject

This is necessary for uniq to properly identify two FHIR models as being identical



22
23
24
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 22

def hash
  to_hash.hash
end

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



73
74
75
76
77
78
79
80
81
82
83
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 73

def mismatch(other, exclude = [])
  misses = []
  (self.class::METADATA.keys - exclude).each do |key|
    these = attribute_mismatch(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

#primitive?(datatype, value) ⇒ Boolean

Returns:

  • (Boolean)


275
276
277
278
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 275

def primitive?(datatype, value)
  FHIR::STU3.logger.warn("prefer using FHIR::STU3.primitive? Called from #{caller.first}")
  FHIR::STU3.primitive?(datatype: datatype, value: value)
end

#to_referenceObject



62
63
64
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 62

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

#valid?Boolean

Returns:

  • (Boolean)


105
106
107
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 105

def valid?
  validate.empty?
end

#validate(contained = nil) ⇒ Object



110
111
112
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 110

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

#validate_profile(metadata, contained = nil) ⇒ Object



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
158
159
160
161
162
163
164
165
166
167
# File 'lib/fhir_stu3_models/bootstrap/model.rb', line 114

def validate_profile(, contained = nil)
  contained_here = [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 = [instance_variable_get("@#{local_name}".to_sym)].flatten.compact
        subset = [] # subset is the values associated with just this slice
        if slice['type'] == 'Extension'
          subset = if slice['type_profiles']
                     value.select { |x| slice['type_profiles'].include?(x.url) }
                   else
                     value
                   end
        else
          FHIR::STU3.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 = [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 = begin
                     self.class::MULTIPLE_TYPES
                   rescue
                     {}
                   end
  multiple_types.each do |prefix, suffixes|
    present = []
    suffixes.each do |suffix|
      typename = "#{prefix}#{suffix[0].upcase}#{suffix[1..-1]}"
      # check which multiple data types are actually present, not just errors
      # actually, this might be allowed depending on cardinality
      value = 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 present.length > 1
    # remove errors for suffixes that are not present
    next unless present.length == 1
    suffixes.each do |suffix|
      typename = "#{prefix}#{suffix[0].upcase}#{suffix[1..-1]}"
      errors.delete(typename) unless present.include?(typename)
    end
  end
  errors.keep_if { |_k, v| (v && !v.empty?) }
end