Class: FHIR::R5::Encounter

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

Defined Under Namespace

Classes: Admission, Diagnosis, Location, Participant, Reason

Constant Summary collapse

SEARCH_PARAMS = 
['account', 'appointment', 'based-on', 'careteam', 'class', 'date', 'date-start', 'diagnosis-code', 'diagnosis-reference', 'end-date', 'episode-of-care', 'identifier', 'length', 'location', 'location-period', 'part-of', 'participant', 'participant-type', 'patient', 'practitioner', 'reason-code', 'reason-reference', 'service-provider', 'special-arrangement', 'status', 'subject', 'subject-status', 'type']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'Encounter.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'Encounter.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'Encounter.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'Encounter.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'=>'Encounter.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'Encounter.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'Encounter.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Encounter.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'Encounter.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/encounter-status'=>['planned', 'in-progress', 'on-hold', 'discharged', 'completed', 'cancelled', 'discontinued', 'entered-in-error', 'unknown']}, 'type'=>'code', 'path'=>'Encounter.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-status'}},
  'class' => {'local_name'=>'local_class', 'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ActCode'=>['IMP', 'AMB', 'OBSENC', 'EMER', 'VR', 'HH']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.class', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://terminology.hl7.org/ValueSet/encounter-class'}},
  'priority' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ActPriority'=>['A', 'CR', 'EL', 'EM', 'P', 'PRN', 'R', 'RR', 'S', 'T', 'UD', 'UR', 'CS', 'CSP', 'CSR']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/ValueSet/v3-ActPriority'}},
  'type' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/encounter-type'=>['ADMS', 'BD/BM-clin', 'CCS60', 'OKI']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.type', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-type'}},
  'serviceType' => {'type'=>'CodeableReference', 'path'=>'Encounter.serviceType', 'min'=>0, 'max'=>Float::INFINITY},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'Encounter.subject', 'min'=>0, 'max'=>1},
  'subjectStatus' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/encounter-subject-status'=>['arrived', 'triaged', 'receiving-care', 'on-leave', 'departed']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.subjectStatus', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-subject-status'}},
  'episodeOfCare' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/EpisodeOfCare'], 'type'=>'Reference', 'path'=>'Encounter.episodeOfCare', 'min'=>0, 'max'=>Float::INFINITY},
  'basedOn' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest'], 'type'=>'Reference', 'path'=>'Encounter.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'careTeam' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CareTeam'], 'type'=>'Reference', 'path'=>'Encounter.careTeam', 'min'=>0, 'max'=>Float::INFINITY},
  'partOf' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'Encounter.partOf', 'min'=>0, 'max'=>1},
  'serviceProvider' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'Encounter.serviceProvider', 'min'=>0, 'max'=>1},
  'participant' => {'type'=>'Encounter::Participant', 'path'=>'Encounter.participant', 'min'=>0, 'max'=>Float::INFINITY},
  'appointment' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Appointment'], 'type'=>'Reference', 'path'=>'Encounter.appointment', 'min'=>0, 'max'=>Float::INFINITY},
  'virtualService' => {'type'=>'VirtualServiceDetail', 'path'=>'Encounter.virtualService', 'min'=>0, 'max'=>Float::INFINITY},
  'actualPeriod' => {'type'=>'Period', 'path'=>'Encounter.actualPeriod', 'min'=>0, 'max'=>1},
  'plannedStartDate' => {'type'=>'dateTime', 'path'=>'Encounter.plannedStartDate', 'min'=>0, 'max'=>1},
  'plannedEndDate' => {'type'=>'dateTime', 'path'=>'Encounter.plannedEndDate', 'min'=>0, 'max'=>1},
  'length' => {'type'=>'Duration', 'path'=>'Encounter.length', 'min'=>0, 'max'=>1},
  'reason' => {'type'=>'Encounter::Reason', 'path'=>'Encounter.reason', 'min'=>0, 'max'=>Float::INFINITY},
  'diagnosis' => {'type'=>'Encounter::Diagnosis', 'path'=>'Encounter.diagnosis', 'min'=>0, 'max'=>Float::INFINITY},
  'account' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Account'], 'type'=>'Reference', 'path'=>'Encounter.account', 'min'=>0, 'max'=>Float::INFINITY},
  'dietPreference' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/diet'=>['vegetarian', 'dairy-free', 'nut-free', 'gluten-free', 'vegan', 'halal', 'kosher']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.dietPreference', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-diet'}},
  'specialArrangement' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/encounter-special-arrangements'=>['wheel', 'add-bed', 'int', 'att', 'dog']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.specialArrangement', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-special-arrangements'}},
  'specialCourtesy' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy'=>['EXT', 'NRM', 'PRF', 'STF', 'VIP'], 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor'=>['UNK']}, 'type'=>'CodeableConcept', 'path'=>'Encounter.specialCourtesy', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/encounter-special-courtesy'}},
  'admission' => {'type'=>'Encounter::Admission', 'path'=>'Encounter.admission', 'min'=>0, 'max'=>1},
  'location' => {'type'=>'Encounter::Location', 'path'=>'Encounter.location', '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

#account ⇒ Object

0-* [ Reference(Account) ]



192
193
194
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 192

def 
  @account
end

#actualPeriod ⇒ Object

0-1 Period



186
187
188
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 186

def actualPeriod
  @actualPeriod
end

#admission ⇒ Object

0-1 Encounter::Admission



196
197
198
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 196

def admission
  @admission
end

#appointment ⇒ Object

0-* [ Reference(Appointment) ]



184
185
186
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 184

def appointment
  @appointment
end

#basedOn ⇒ Object

0-* [ Reference(CarePlan|DeviceRequest|MedicationRequest|ServiceRequest) ]



179
180
181
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 179

def basedOn
  @basedOn
end

#careTeam ⇒ Object

0-* [ Reference(CareTeam) ]



180
181
182
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 180

def careTeam
  @careTeam
end

#contained ⇒ Object

0-* [ Resource ]



167
168
169
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 167

def contained
  @contained
end

#diagnosis ⇒ Object

0-* [ Encounter::Diagnosis ]



191
192
193
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 191

def diagnosis
  @diagnosis
end

#dietPreference ⇒ Object

0-* [ CodeableConcept ]



193
194
195
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 193

def dietPreference
  @dietPreference
end

#episodeOfCare ⇒ Object

0-* [ Reference(EpisodeOfCare) ]



178
179
180
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 178

def episodeOfCare
  @episodeOfCare
end

#extension ⇒ Object

0-* [ Extension ]



168
169
170
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 168

def extension
  @extension
end

#id ⇒ Object

0-1 id



162
163
164
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 162

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



170
171
172
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 170

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



164
165
166
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 164

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



165
166
167
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 165

def language
  @language
end

#length ⇒ Object

0-1 Duration



189
190
191
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 189

def length
  @length
end

#local_class ⇒ Object

0-* [ CodeableConcept ]



172
173
174
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 172

def local_class
  @local_class
end

#location ⇒ Object

0-* [ Encounter::Location ]



197
198
199
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 197

def location
  @location
end

#meta ⇒ Object

0-1 Meta



163
164
165
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 163

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



169
170
171
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 169

def modifierExtension
  @modifierExtension
end

#participant ⇒ Object

0-* [ Encounter::Participant ]



183
184
185
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 183

def participant
  @participant
end

#partOf ⇒ Object

0-1 Reference(Encounter)



181
182
183
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 181

def partOf
  @partOf
end

#plannedEndDate ⇒ Object

0-1 dateTime



188
189
190
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 188

def plannedEndDate
  @plannedEndDate
end

#plannedStartDate ⇒ Object

0-1 dateTime



187
188
189
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 187

def plannedStartDate
  @plannedStartDate
end

#priority ⇒ Object

0-1 CodeableConcept



173
174
175
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 173

def priority
  @priority
end

#reason ⇒ Object

0-* [ Encounter::Reason ]



190
191
192
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 190

def reason
  @reason
end

#serviceProvider ⇒ Object

0-1 Reference(Organization)



182
183
184
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 182

def serviceProvider
  @serviceProvider
end

#serviceType ⇒ Object

0-* [ CodeableReference ]



175
176
177
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 175

def serviceType
  @serviceType
end

#specialArrangement ⇒ Object

0-* [ CodeableConcept ]



194
195
196
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 194

def specialArrangement
  @specialArrangement
end

#specialCourtesy ⇒ Object

0-* [ CodeableConcept ]



195
196
197
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 195

def specialCourtesy
  @specialCourtesy
end

#status ⇒ Object

1-1 code



171
172
173
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 171

def status
  @status
end

#subject ⇒ Object

0-1 Reference(Patient|Group)



176
177
178
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 176

def subject
  @subject
end

#subjectStatus ⇒ Object

0-1 CodeableConcept



177
178
179
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 177

def subjectStatus
  @subjectStatus
end

#text ⇒ Object

0-1 Narrative



166
167
168
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 166

def text
  @text
end

#type ⇒ Object

0-* [ CodeableConcept ]



174
175
176
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 174

def type
  @type
end

#virtualService ⇒ Object

0-* [ VirtualServiceDetail ]



185
186
187
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 185

def virtualService
  @virtualService
end

Instance Method Details

#resourceType ⇒ Object 



199
200
201
 
# File 'lib/fhir_models/r5/generated/resources/Encounter.rb', line 199

def resourceType
  'Encounter'
end