Module: Inferno::DSL::FHIRValidation Deprecated

Included in:
Entities::TestGroup, Entities::TestSuite
Defined in:
lib/inferno/dsl/fhir_validation.rb

Overview

Deprecated.

Use FHIRResourceValidation instead

This module contains the methods needed to configure a validator to perform validation of FHIR resources. The actual validation is performed by an external FHIR validation service. Tests will typically rely on assert_valid_resource for validation rather than directly calling methods on a validator.

Examples:


validator do
  url 'http://example.com/validator'
  exclude_message { |message| message.type == 'info' }
  perform_additional_validation do |resource, profile_url|
    if something_is_wrong
      { type: 'error', message: 'something is wrong' }
    else
      { type: 'info', message: 'everything is ok' }
    end
  end
end

Defined Under Namespace

Modules: ClassMethods Classes: Validator

Instance Method Summary collapse

Instance Method Details

#conforms_to_logical_model?(object, model_url, validator: :default, add_messages_to_runnable: true, message_prefix: '', validator_response_details: nil) ⇒ Boolean

Perform validation, and add validation messages to the runnable

Parameters:

  • object (Hash) —

    json to verify against the model, as a Hash

  • model_url (String)
  • validator (Symbol) (defaults to: :default) —

    the name of the validator to use

  • add_messages_to_runnable (Boolean) (defaults to: true) —

    whether to add validation messages to runnable or not

  • message_prefix (String) (defaults to: '') —

    Prefix to add to the start of logged messages

  • validator_response_details (Array, nil) (defaults to: nil) —

    if not nil, the service will populate this array with the detailed response message from the validator service

Returns:

  • (Boolean) —

    whether the resource is valid



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/inferno/dsl/fhir_validation.rb', line 61

def conforms_to_logical_model?(
  object, model_url,
  validator: :default, add_messages_to_runnable: true, message_prefix: '',
  validator_response_details: nil
)
  find_validator(validator).conforms_to_logical_model?(object, model_url, self,
                                                       add_messages_to_runnable:,
                                                       message_prefix:,
                                                       validator_response_details:)
end

#find_validator(validator_name) ⇒ Object

Find a particular validator. Looks through a runnable’s parents up to the suite to find a validator with a particular name



74
75
76
 
# File 'lib/inferno/dsl/fhir_validation.rb', line 74

def find_validator(validator_name)
  self.class.find_validator(validator_name, suite_options)
end

#resource_is_valid?(resource: self.resource, profile_url: nil, validator: :default, add_messages_to_runnable: true, message_prefix: '', validator_response_details: nil) ⇒ Boolean

Perform validation, and add validation messages to the runnable

Parameters:

  • resource (FHIR::Model) (defaults to: self.resource)
  • profile_url (String) (defaults to: nil)
  • validator (Symbol) (defaults to: :default) —

    the name of the validator to use

  • add_messages_to_runnable (Boolean) (defaults to: true) —

    whether to add validation messages to runnable or not

  • message_prefix (String) (defaults to: '') —

    Prefix to add to the start of logged messages

  • validator_response_details (Array, nil) (defaults to: nil) —

    if not nil, the service will populate this array with the detailed response message from the validator service

Returns:

  • (Boolean) —

    whether the resource is valid



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/inferno/dsl/fhir_validation.rb', line 40

def resource_is_valid?(
  resource: self.resource, profile_url: nil,
  validator: :default, add_messages_to_runnable: true, message_prefix: '',
  validator_response_details: nil
)
  find_validator(validator).resource_is_valid?(resource, profile_url, self,
                                               add_messages_to_runnable:,
                                               message_prefix:,
                                               validator_response_details:)
end