Class: FHIR::ExplanationOfBenefit

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

Defined Under Namespace

Classes: Accident, AddItem, BenefitBalance, CareTeam, Diagnosis, Insurance, Item, Payee, Payment, Procedure, ProcessNote, Related, SupportingInfo, Total

Constant Summary collapse

SEARCH_PARAMS =
['care-team', 'claim', 'coverage', 'created', 'detail-udi', 'disposition', 'encounter', 'enterer', 'facility', 'identifier', 'item-udi', 'patient', 'payee', 'procedure-udi', 'provider', 'status', 'subdetail-udi']
METADATA =
{
  'id' => {'type'=>'id', 'path'=>'ExplanationOfBenefit.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'ExplanationOfBenefit.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'ExplanationOfBenefit.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'valid_codes'=>{'urn:ietf:bcp:47'=>['ar', 'bn', 'cs', 'da', 'de', 'de-AT', 'de-CH', 'de-DE', 'el', 'en', 'en-AU', 'en-CA', 'en-GB', 'en-IN', 'en-NZ', 'en-SG', 'en-US', 'es', 'es-AR', 'es-ES', 'es-UY', 'fi', 'fr', 'fr-BE', 'fr-CH', 'fr-FR', 'fy', 'fy-NL', 'hi', 'hr', 'it', 'it-CH', 'it-IT', 'ja', 'ko', 'nl', 'nl-BE', 'nl-NL', 'no', 'no-NO', 'pa', 'pl', 'pt', 'pt-BR', 'ru', 'ru-RU', 'sr', 'sr-RS', 'sv', 'sv-SE', 'te', 'zh', 'zh-CN', 'zh-HK', 'zh-SG', 'zh-TW']}, 'type'=>'code', 'path'=>'ExplanationOfBenefit.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'ExplanationOfBenefit.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'ExplanationOfBenefit.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'ExplanationOfBenefit.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'ExplanationOfBenefit.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'ExplanationOfBenefit.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/explanationofbenefit-status'=>['active', 'cancelled', 'draft', 'entered-in-error']}, 'type'=>'code', 'path'=>'ExplanationOfBenefit.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.0'}},
  'type' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/claim-type'=>['institutional', 'oral', 'pharmacy', 'professional', 'vision']}, 'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/claim-type'}},
  'subType' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/ex-claimsubtype'=>['ortho', 'emergency']}, 'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.subType', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/claim-subtype'}},
  'use' => {'valid_codes'=>{'http://hl7.org/fhir/claim-use'=>['claim', 'preauthorization', 'predetermination']}, 'type'=>'code', 'path'=>'ExplanationOfBenefit.use', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/claim-use|4.0.0'}},
  'patient' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.patient', 'min'=>1, 'max'=>1},
  'billablePeriod' => {'type'=>'Period', 'path'=>'ExplanationOfBenefit.billablePeriod', 'min'=>0, 'max'=>1},
  'created' => {'type'=>'dateTime', 'path'=>'ExplanationOfBenefit.created', 'min'=>1, 'max'=>1},
  'enterer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.enterer', 'min'=>0, 'max'=>1},
  'insurer' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.insurer', 'min'=>1, 'max'=>1},
  'provider' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.provider', 'min'=>1, 'max'=>1},
  'priority' => {'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/CodeSystem/processpriority'}},
  'fundsReserveRequested' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/fundsreserve'=>['patient', 'provider', 'none']}, 'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.fundsReserveRequested', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/fundsreserve'}},
  'fundsReserve' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/fundsreserve'=>['patient', 'provider', 'none']}, 'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.fundsReserve', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/fundsreserve'}},
  'related' => {'type'=>'ExplanationOfBenefit::Related', 'path'=>'ExplanationOfBenefit.related', 'min'=>0, 'max'=>Float::INFINITY},
  'prescription' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/VisionPrescription'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.prescription', 'min'=>0, 'max'=>1},
  'originalPrescription' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/MedicationRequest'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.originalPrescription', 'min'=>0, 'max'=>1},
  'payee' => {'type'=>'ExplanationOfBenefit::Payee', 'path'=>'ExplanationOfBenefit.payee', 'min'=>0, 'max'=>1},
  'referral' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ServiceRequest'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.referral', 'min'=>0, 'max'=>1},
  'facility' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Location'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.facility', 'min'=>0, 'max'=>1},
  'claim' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Claim'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.claim', 'min'=>0, 'max'=>1},
  'claimResponse' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/ClaimResponse'], 'type'=>'Reference', 'path'=>'ExplanationOfBenefit.claimResponse', 'min'=>0, 'max'=>1},
  'outcome' => {'valid_codes'=>{'http://hl7.org/fhir/remittance-outcome'=>['queued', 'complete', 'error', 'partial']}, 'type'=>'code', 'path'=>'ExplanationOfBenefit.outcome', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0'}},
  'disposition' => {'type'=>'string', 'path'=>'ExplanationOfBenefit.disposition', 'min'=>0, 'max'=>1},
  'preAuthRef' => {'type'=>'string', 'path'=>'ExplanationOfBenefit.preAuthRef', 'min'=>0, 'max'=>Float::INFINITY},
  'preAuthRefPeriod' => {'type'=>'Period', 'path'=>'ExplanationOfBenefit.preAuthRefPeriod', 'min'=>0, 'max'=>Float::INFINITY},
  'careTeam' => {'type'=>'ExplanationOfBenefit::CareTeam', 'path'=>'ExplanationOfBenefit.careTeam', 'min'=>0, 'max'=>Float::INFINITY},
  'supportingInfo' => {'type'=>'ExplanationOfBenefit::SupportingInfo', 'path'=>'ExplanationOfBenefit.supportingInfo', 'min'=>0, 'max'=>Float::INFINITY},
  'diagnosis' => {'type'=>'ExplanationOfBenefit::Diagnosis', 'path'=>'ExplanationOfBenefit.diagnosis', 'min'=>0, 'max'=>Float::INFINITY},
  'procedure' => {'type'=>'ExplanationOfBenefit::Procedure', 'path'=>'ExplanationOfBenefit.procedure', 'min'=>0, 'max'=>Float::INFINITY},
  'precedence' => {'type'=>'positiveInt', 'path'=>'ExplanationOfBenefit.precedence', 'min'=>0, 'max'=>1},
  'insurance' => {'type'=>'ExplanationOfBenefit::Insurance', 'path'=>'ExplanationOfBenefit.insurance', 'min'=>1, 'max'=>Float::INFINITY},
  'accident' => {'type'=>'ExplanationOfBenefit::Accident', 'path'=>'ExplanationOfBenefit.accident', 'min'=>0, 'max'=>1},
  'item' => {'type'=>'ExplanationOfBenefit::Item', 'path'=>'ExplanationOfBenefit.item', 'min'=>0, 'max'=>Float::INFINITY},
  'addItem' => {'type'=>'ExplanationOfBenefit::AddItem', 'path'=>'ExplanationOfBenefit.addItem', 'min'=>0, 'max'=>Float::INFINITY},
  'adjudication' => {'type'=>'ExplanationOfBenefit::Item::Adjudication', 'path'=>'ExplanationOfBenefit.adjudication', 'min'=>0, 'max'=>Float::INFINITY},
  'total' => {'type'=>'ExplanationOfBenefit::Total', 'path'=>'ExplanationOfBenefit.total', 'min'=>0, 'max'=>Float::INFINITY},
  'payment' => {'type'=>'ExplanationOfBenefit::Payment', 'path'=>'ExplanationOfBenefit.payment', 'min'=>0, 'max'=>1},
  'formCode' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/forms-codes'=>['1', '2']}, 'type'=>'CodeableConcept', 'path'=>'ExplanationOfBenefit.formCode', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/forms'}},
  'form' => {'type'=>'Attachment', 'path'=>'ExplanationOfBenefit.form', 'min'=>0, 'max'=>1},
  'processNote' => {'type'=>'ExplanationOfBenefit::ProcessNote', 'path'=>'ExplanationOfBenefit.processNote', 'min'=>0, 'max'=>Float::INFINITY},
  'benefitPeriod' => {'type'=>'Period', 'path'=>'ExplanationOfBenefit.benefitPeriod', 'min'=>0, 'max'=>1},
  'benefitBalance' => {'type'=>'ExplanationOfBenefit::BenefitBalance', 'path'=>'ExplanationOfBenefit.benefitBalance', 'min'=>0, 'max'=>Float::INFINITY}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Xml

from_xml, #to_xml, valid?, validate

Methods included from Deprecate

#deprecate

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?, #hash, #initialize, #method_missing, #mismatch, #primitive?, #to_reference, #valid?, #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

#accidentObject

0-1 ExplanationOfBenefit::Accident



769
770
771
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 769

def accident
  @accident
end

#addItemObject

0-* [ ExplanationOfBenefit::AddItem ]



771
772
773
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 771

def addItem
  @addItem
end

#adjudicationObject

0-* [ ExplanationOfBenefit::Item::Adjudication ]



772
773
774
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 772

def adjudication
  @adjudication
end

#benefitBalanceObject

0-* [ ExplanationOfBenefit::BenefitBalance ]



779
780
781
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 779

def benefitBalance
  @benefitBalance
end

#benefitPeriodObject

0-1 Period



778
779
780
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 778

def benefitPeriod
  @benefitPeriod
end

#billablePeriodObject

0-1 Period



743
744
745
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 743

def billablePeriod
  @billablePeriod
end

#careTeamObject

0-* [ ExplanationOfBenefit::CareTeam ]



763
764
765
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 763

def careTeam
  @careTeam
end

#claimObject

0-1 Reference(Claim)



757
758
759
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 757

def claim
  @claim
end

#claimResponseObject

0-1 Reference(ClaimResponse)



758
759
760
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 758

def claimResponse
  @claimResponse
end

#containedObject

0-* [ Resource ]



734
735
736
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 734

def contained
  @contained
end

#createdObject

1-1 dateTime



744
745
746
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 744

def created
  @created
end

#diagnosisObject

0-* [ ExplanationOfBenefit::Diagnosis ]



765
766
767
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 765

def diagnosis
  @diagnosis
end

#dispositionObject

0-1 string



760
761
762
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 760

def disposition
  @disposition
end

#entererObject

0-1 Reference(Practitioner|PractitionerRole)



745
746
747
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 745

def enterer
  @enterer
end

#extensionObject

0-* [ Extension ]



735
736
737
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 735

def extension
  @extension
end

#facilityObject

0-1 Reference(Location)



756
757
758
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 756

def facility
  @facility
end

#formObject

0-1 Attachment



776
777
778
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 776

def form
  @form
end

#formCodeObject

0-1 CodeableConcept



775
776
777
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 775

def formCode
  @formCode
end

#fundsReserveObject

0-1 CodeableConcept



750
751
752
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 750

def fundsReserve
  @fundsReserve
end

#fundsReserveRequestedObject

0-1 CodeableConcept



749
750
751
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 749

def fundsReserveRequested
  @fundsReserveRequested
end

#idObject

0-1 id



729
730
731
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 729

def id
  @id
end

#identifierObject

0-* [ Identifier ]



737
738
739
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 737

def identifier
  @identifier
end

#implicitRulesObject

0-1 uri



731
732
733
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 731

def implicitRules
  @implicitRules
end

#insuranceObject

1-* [ ExplanationOfBenefit::Insurance ]



768
769
770
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 768

def insurance
  @insurance
end

#insurerObject

1-1 Reference(Organization)



746
747
748
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 746

def insurer
  @insurer
end

#itemObject

0-* [ ExplanationOfBenefit::Item ]



770
771
772
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 770

def item
  @item
end

#languageObject

0-1 code



732
733
734
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 732

def language
  @language
end

#metaObject

0-1 Meta



730
731
732
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 730

def meta
  @meta
end

#modifierExtensionObject

0-* [ Extension ]



736
737
738
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 736

def modifierExtension
  @modifierExtension
end

#originalPrescriptionObject

0-1 Reference(MedicationRequest)



753
754
755
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 753

def originalPrescription
  @originalPrescription
end

#outcomeObject

1-1 code



759
760
761
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 759

def outcome
  @outcome
end

#patientObject

1-1 Reference(Patient)



742
743
744
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 742

def patient
  @patient
end

#payeeObject

0-1 ExplanationOfBenefit::Payee



754
755
756
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 754

def payee
  @payee
end

#paymentObject

0-1 ExplanationOfBenefit::Payment



774
775
776
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 774

def payment
  @payment
end

#preAuthRefObject

0-* [ string ]



761
762
763
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 761

def preAuthRef
  @preAuthRef
end

#preAuthRefPeriodObject

0-* [ Period ]



762
763
764
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 762

def preAuthRefPeriod
  @preAuthRefPeriod
end

#precedenceObject

0-1 positiveInt



767
768
769
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 767

def precedence
  @precedence
end

#prescriptionObject

0-1 Reference(MedicationRequest|VisionPrescription)



752
753
754
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 752

def prescription
  @prescription
end

#priorityObject

0-1 CodeableConcept



748
749
750
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 748

def priority
  @priority
end

#procedureObject

0-* [ ExplanationOfBenefit::Procedure ]



766
767
768
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 766

def procedure
  @procedure
end

#processNoteObject

0-* [ ExplanationOfBenefit::ProcessNote ]



777
778
779
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 777

def processNote
  @processNote
end

#providerObject

1-1 Reference(Practitioner|PractitionerRole|Organization)



747
748
749
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 747

def provider
  @provider
end

#referralObject

0-1 Reference(ServiceRequest)



755
756
757
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 755

def referral
  @referral
end

0-* [ ExplanationOfBenefit::Related ]



751
752
753
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 751

def related
  @related
end

#statusObject

1-1 code



738
739
740
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 738

def status
  @status
end

#subTypeObject

0-1 CodeableConcept



740
741
742
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 740

def subType
  @subType
end

#supportingInfoObject

0-* [ ExplanationOfBenefit::SupportingInfo ]



764
765
766
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 764

def supportingInfo
  @supportingInfo
end

#textObject

0-1 Narrative



733
734
735
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 733

def text
  @text
end

#totalObject

0-* [ ExplanationOfBenefit::Total ]



773
774
775
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 773

def total
  @total
end

#typeObject

1-1 CodeableConcept



739
740
741
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 739

def type
  @type
end

#useObject

1-1 code



741
742
743
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 741

def use
  @use
end

Instance Method Details

#resourceTypeObject



781
782
783
# File 'lib/fhir_models/fhir/resources/ExplanationOfBenefit.rb', line 781

def resourceType
  'ExplanationOfBenefit'
end