Class: FHIR::R5::Appointment

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

Defined Under Namespace

Classes: Participant, RecurrenceTemplate

Constant Summary collapse

SEARCH_PARAMS = 
['actor', 'appointment-type', 'based-on', 'date', 'group', 'identifier', 'location', 'part-status', 'patient', 'practitioner', 'reason-code', 'reason-reference', 'requested-period', 'service-category', 'service-type', 'service-type-reference', 'slot', 'specialty', 'status', 'subject', 'supporting-info']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'Appointment.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'Appointment.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'Appointment.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'Appointment.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'=>'Appointment.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'Appointment.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'Appointment.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Appointment.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'Appointment.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/appointmentstatus'=>['proposed', 'pending', 'booked', 'arrived', 'fulfilled', 'cancelled', 'noshow', 'entered-in-error', 'checked-in', 'waitlist']}, 'type'=>'code', 'path'=>'Appointment.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/appointmentstatus'}},
  'cancellationReason' => {'type'=>'CodeableConcept', 'path'=>'Appointment.cancellationReason', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/appointment-cancellation-reason'}},
  'class' => {'local_name'=>'local_class', 'type'=>'CodeableConcept', 'path'=>'Appointment.class', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://terminology.hl7.org/ValueSet/EncounterClass'}},
  'serviceCategory' => {'type'=>'CodeableConcept', 'path'=>'Appointment.serviceCategory', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/service-category'}},
  'serviceType' => {'type'=>'CodeableReference', 'path'=>'Appointment.serviceType', 'min'=>0, 'max'=>Float::INFINITY},
  'specialty' => {'valid_codes'=>{'http://snomed.info/sct'=>['408467006', '394577000', '394578005', '421661004', '408462000', '394579002', '394804000', '394580004', '394803006', '408480009', '408454008', '394809005', '394592004', '394600006', '394601005', '394581000', '408478003', '394812008', '408444009', '394582007', '408475000', '410005002', '394583002', '419772000', '394584008', '408443003', '394802001', '394915009', '394814009', '394808002', '394811001', '408446006', '394586005', '394916005', '408472002', '394597005', '394598000', '394807007', '419192003', '408468001', '394593009', '394813003', '410001006', '394589003', '394591006', '394599008', '394649004', '408470005', '394585009', '394821009', '422191005', '394594003', '416304004', '418960008', '394882004', '394806003', '394588006', '408459003', '394607009', '419610006', '418058008', '420208008', '418652005', '418535003', '418862001', '419365004', '418002000', '419983000', '419170002', '419472004', '394539006', '420112009', '409968004', '394587001', '394913002', '408440000', '418112009', '419815003', '394914008', '408455009', '394602003', '408447002', '394810000', '408450004', '408476004', '408469009', '408466002', '408471009', '408464004', '408441001', '408465003', '394605001', '394608004', '408461007', '408460008', '394606000', '408449004', '418018006', '394604002', '394609007', '408474001', '394610002', '394611003', '408477008', '394801008', '408463005', '419321007', '394576009', '394590007', '409967009', '408448007', '419043006', '394612005', '394733009', '394732004']}, 'type'=>'CodeableConcept', 'path'=>'Appointment.specialty', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/c80-practice-codes'}},
  'appointmentType' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v2-0276'=>['ROUTINE', 'WALKIN', 'CHECKUP', 'FOLLOWUP', 'EMERGENCY']}, 'type'=>'CodeableConcept', 'path'=>'Appointment.appointmentType', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://terminology.hl7.org/ValueSet/v2-0276'}},
  'reason' => {'type'=>'CodeableReference', 'path'=>'Appointment.reason', 'min'=>0, 'max'=>Float::INFINITY},
  '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'=>'Appointment.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/ValueSet/v3-ActPriority'}},
  'description' => {'type'=>'string', 'path'=>'Appointment.description', 'min'=>0, 'max'=>1},
  'replaces' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Appointment'], 'type'=>'Reference', 'path'=>'Appointment.replaces', 'min'=>0, 'max'=>Float::INFINITY},
  'virtualService' => {'type'=>'VirtualServiceDetail', 'path'=>'Appointment.virtualService', 'min'=>0, 'max'=>Float::INFINITY},
  'supportingInformation' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'Appointment.supportingInformation', 'min'=>0, 'max'=>Float::INFINITY},
  'previousAppointment' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Appointment'], 'type'=>'Reference', 'path'=>'Appointment.previousAppointment', 'min'=>0, 'max'=>1},
  'originatingAppointment' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Appointment'], 'type'=>'Reference', 'path'=>'Appointment.originatingAppointment', 'min'=>0, 'max'=>1},
  'start' => {'type'=>'instant', 'path'=>'Appointment.start', 'min'=>0, 'max'=>1},
  'end' => {'type'=>'instant', 'path'=>'Appointment.end', 'min'=>0, 'max'=>1},
  'minutesDuration' => {'type'=>'positiveInt', 'path'=>'Appointment.minutesDuration', 'min'=>0, 'max'=>1},
  'requestedPeriod' => {'type'=>'Period', 'path'=>'Appointment.requestedPeriod', 'min'=>0, 'max'=>Float::INFINITY},
  'slot' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Slot'], 'type'=>'Reference', 'path'=>'Appointment.slot', 'min'=>0, 'max'=>Float::INFINITY},
  'account' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Account'], 'type'=>'Reference', 'path'=>'Appointment.account', 'min'=>0, 'max'=>Float::INFINITY},
  'created' => {'type'=>'dateTime', 'path'=>'Appointment.created', 'min'=>0, 'max'=>1},
  'cancellationDate' => {'type'=>'dateTime', 'path'=>'Appointment.cancellationDate', 'min'=>0, 'max'=>1},
  'note' => {'type'=>'Annotation', 'path'=>'Appointment.note', 'min'=>0, 'max'=>Float::INFINITY},
  'patientInstruction' => {'type'=>'CodeableReference', 'path'=>'Appointment.patientInstruction', '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'=>'Appointment.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'Appointment.subject', 'min'=>0, 'max'=>1},
  'participant' => {'type'=>'Appointment::Participant', 'path'=>'Appointment.participant', 'min'=>1, 'max'=>Float::INFINITY},
  'recurrenceId' => {'type'=>'positiveInt', 'path'=>'Appointment.recurrenceId', 'min'=>0, 'max'=>1},
  'occurrenceChanged' => {'type'=>'boolean', 'path'=>'Appointment.occurrenceChanged', 'min'=>0, 'max'=>1},
  'recurrenceTemplate' => {'type'=>'Appointment::RecurrenceTemplate', 'path'=>'Appointment.recurrenceTemplate', '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) ]



217
218
219
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 217

def 
  @account
end

#appointmentType ⇒ Object

0-1 CodeableConcept



203
204
205
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 203

def appointmentType
  @appointmentType
end

#basedOn ⇒ Object

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



222
223
224
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 222

def basedOn
  @basedOn
end

#cancellationDate ⇒ Object

0-1 dateTime



219
220
221
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 219

def cancellationDate
  @cancellationDate
end

#cancellationReason ⇒ Object

0-1 CodeableConcept



198
199
200
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 198

def cancellationReason
  @cancellationReason
end

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#created ⇒ Object

0-1 dateTime



218
219
220
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 218

def created
  @created
end

#description ⇒ Object

0-1 string



206
207
208
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 206

def description
  @description
end

#end ⇒ Object

0-1 instant



213
214
215
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 213

def end
  @end
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#id ⇒ Object

0-1 id



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

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#local_class ⇒ Object

0-* [ CodeableConcept ]



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

def local_class
  @local_class
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#minutesDuration ⇒ Object

0-1 positiveInt



214
215
216
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 214

def minutesDuration
  @minutesDuration
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



220
221
222
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 220

def note
  @note
end

#occurrenceChanged ⇒ Object

0-1 boolean



226
227
228
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 226

def occurrenceChanged
  @occurrenceChanged
end

#originatingAppointment ⇒ Object

0-1 Reference(Appointment)



211
212
213
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 211

def originatingAppointment
  @originatingAppointment
end

#participant ⇒ Object

1-* [ Appointment::Participant ]



224
225
226
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 224

def participant
  @participant
end

#patientInstruction ⇒ Object

0-* [ CodeableReference ]



221
222
223
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 221

def patientInstruction
  @patientInstruction
end

#previousAppointment ⇒ Object

0-1 Reference(Appointment)



210
211
212
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 210

def previousAppointment
  @previousAppointment
end

#priority ⇒ Object

0-1 CodeableConcept



205
206
207
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 205

def priority
  @priority
end

#reason ⇒ Object

0-* [ CodeableReference ]



204
205
206
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 204

def reason
  @reason
end

#recurrenceId ⇒ Object

0-1 positiveInt



225
226
227
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 225

def recurrenceId
  @recurrenceId
end

#recurrenceTemplate ⇒ Object

0-* [ Appointment::RecurrenceTemplate ]



227
228
229
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 227

def recurrenceTemplate
  @recurrenceTemplate
end

#replaces ⇒ Object

0-* [ Reference(Appointment) ]



207
208
209
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 207

def replaces
  @replaces
end

#requestedPeriod ⇒ Object

0-* [ Period ]



215
216
217
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 215

def requestedPeriod
  @requestedPeriod
end

#serviceCategory ⇒ Object

0-* [ CodeableConcept ]



200
201
202
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 200

def serviceCategory
  @serviceCategory
end

#serviceType ⇒ Object

0-* [ CodeableReference ]



201
202
203
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 201

def serviceType
  @serviceType
end

#slot ⇒ Object

0-* [ Reference(Slot) ]



216
217
218
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 216

def slot
  @slot
end

#specialty ⇒ Object

0-* [ CodeableConcept ]



202
203
204
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 202

def specialty
  @specialty
end

#start ⇒ Object

0-1 instant



212
213
214
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 212

def start
  @start
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#subject ⇒ Object

0-1 Reference(Patient|Group)



223
224
225
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 223

def subject
  @subject
end

#supportingInformation ⇒ Object

0-* [ Reference(Resource) ]



209
210
211
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 209

def supportingInformation
  @supportingInformation
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

#virtualService ⇒ Object

0-* [ VirtualServiceDetail ]



208
209
210
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 208

def virtualService
  @virtualService
end

Instance Method Details

#resourceType ⇒ Object 



229
230
231
 
# File 'lib/fhir_models/r5/generated/resources/Appointment.rb', line 229

def resourceType
  'Appointment'
end