Class: FHIR::R5::Communication

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

Defined Under Namespace

Classes: Payload

Constant Summary collapse

SEARCH_PARAMS = 
['based-on', 'category', 'encounter', 'identifier', 'instantiates-canonical', 'instantiates-uri', 'medium', 'part-of', 'patient', 'received', 'recipient', 'sender', 'sent', 'status', 'subject', 'topic']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'Communication.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'Communication.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'Communication.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'Communication.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'=>'Communication.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'Communication.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'Communication.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'Communication.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'Communication.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'instantiatesCanonical' => {'type'=>'canonical', 'path'=>'Communication.instantiatesCanonical', 'min'=>0, 'max'=>Float::INFINITY},
  'instantiatesUri' => {'type'=>'uri', 'path'=>'Communication.instantiatesUri', 'min'=>0, 'max'=>Float::INFINITY},
  'basedOn' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'Communication.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'partOf' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'Communication.partOf', 'min'=>0, 'max'=>Float::INFINITY},
  'inResponseTo' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Communication'], 'type'=>'Reference', 'path'=>'Communication.inResponseTo', 'min'=>0, 'max'=>Float::INFINITY},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/event-status'=>['preparation', 'in-progress', 'not-done', 'on-hold', 'stopped', 'completed', 'entered-in-error', 'unknown']}, 'type'=>'code', 'path'=>'Communication.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/event-status'}},
  'statusReason' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/communication-not-done-reason'=>['unknown', 'system-error', 'invalid-phone-number', 'recipient-unavailable', 'family-objection', 'patient-objection']}, 'type'=>'CodeableConcept', 'path'=>'Communication.statusReason', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/communication-not-done-reason'}},
  'category' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/communication-category'=>['alert', 'notification', 'reminder', 'instruction']}, 'type'=>'CodeableConcept', 'path'=>'Communication.category', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/communication-category'}},
  'priority' => {'valid_codes'=>{'http://hl7.org/fhir/request-priority'=>['routine', 'urgent', 'asap', 'stat']}, 'type'=>'code', 'path'=>'Communication.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/request-priority'}},
  'medium' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ParticipationMode'=>['PHYSICAL', 'REMOTE', 'VERBAL', 'DICTATE', 'FACE', 'PHONE', 'VIDEOCONF', 'WRITTEN', 'FAXWRIT', 'HANDWRIT', 'MAILWRIT', 'ONLINEWRIT', 'EMAILWRIT', 'TYPEWRIT', 'MSGWRIT', 'SMSWRIT', 'MMSWRIT', 'APPWRIT', 'ELECTRONIC']}, 'type'=>'CodeableConcept', 'path'=>'Communication.medium', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/ValueSet/v3-ParticipationMode'}},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Group'], 'type'=>'Reference', 'path'=>'Communication.subject', 'min'=>0, 'max'=>1},
  'topic' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/communication-topic'=>['prescription-refill-request', 'progress-update', 'report-labs', 'appointment-reminder', 'phone-consult', 'summary-report']}, 'type'=>'CodeableConcept', 'path'=>'Communication.topic', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/communication-topic'}},
  'about' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'Communication.about', 'min'=>0, 'max'=>Float::INFINITY},
  'encounter' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'Communication.encounter', 'min'=>0, 'max'=>1},
  'sent' => {'type'=>'dateTime', 'path'=>'Communication.sent', 'min'=>0, 'max'=>1},
  'received' => {'type'=>'dateTime', 'path'=>'Communication.received', 'min'=>0, 'max'=>1},
  'recipient' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Endpoint'], 'type'=>'Reference', 'path'=>'Communication.recipient', 'min'=>0, 'max'=>Float::INFINITY},
  'sender' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Endpoint', 'http://hl7.org/fhir/StructureDefinition/CareTeam'], 'type'=>'Reference', 'path'=>'Communication.sender', 'min'=>0, 'max'=>1},
  'reason' => {'type'=>'CodeableReference', 'path'=>'Communication.reason', 'min'=>0, 'max'=>Float::INFINITY},
  'payload' => {'type'=>'Communication::Payload', 'path'=>'Communication.payload', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'Communication.note', '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

#about ⇒ Object

0-* [ Reference(Resource) ]



88
89
90
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 88

def about
  @about
end

#basedOn ⇒ Object

0-* [ Reference(Resource) ]



78
79
80
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 78

def basedOn
  @basedOn
end

#category ⇒ Object

0-* [ CodeableConcept ]



83
84
85
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 83

def category
  @category
end

#contained ⇒ Object

0-* [ Resource ]



72
73
74
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 72

def contained
  @contained
end

#encounter ⇒ Object

0-1 Reference(Encounter)



89
90
91
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 89

def encounter
  @encounter
end

#extension ⇒ Object

0-* [ Extension ]



73
74
75
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 73

def extension
  @extension
end

#id ⇒ Object

0-1 id



67
68
69
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 67

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



75
76
77
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 75

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



69
70
71
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 69

def implicitRules
  @implicitRules
end

#inResponseTo ⇒ Object

0-* [ Reference(Communication) ]



80
81
82
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 80

def inResponseTo
  @inResponseTo
end

#instantiatesCanonical ⇒ Object

0-* [ canonical ]



76
77
78
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 76

def instantiatesCanonical
  @instantiatesCanonical
end

#instantiatesUri ⇒ Object

0-* [ uri ]



77
78
79
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 77

def instantiatesUri
  @instantiatesUri
end

#language ⇒ Object

0-1 code



70
71
72
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 70

def language
  @language
end

#medium ⇒ Object

0-* [ CodeableConcept ]



85
86
87
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 85

def medium
  @medium
end

#meta ⇒ Object

0-1 Meta



68
69
70
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 68

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



74
75
76
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 74

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



96
97
98
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 96

def note
  @note
end

#partOf ⇒ Object

0-* [ Reference(Resource) ]



79
80
81
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 79

def partOf
  @partOf
end

#payload ⇒ Object

0-* [ Communication::Payload ]



95
96
97
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 95

def payload
  @payload
end

#priority ⇒ Object

0-1 code



84
85
86
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 84

def priority
  @priority
end

#reason ⇒ Object

0-* [ CodeableReference ]



94
95
96
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 94

def reason
  @reason
end

#received ⇒ Object

0-1 dateTime



91
92
93
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 91

def received
  @received
end

#recipient ⇒ Object

0-* [ Reference(CareTeam|Device|Group|HealthcareService|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Endpoint) ]



92
93
94
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 92

def recipient
  @recipient
end

#sender ⇒ Object

0-1 Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|HealthcareService|Endpoint|CareTeam)



93
94
95
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 93

def sender
  @sender
end

#sent ⇒ Object

0-1 dateTime



90
91
92
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 90

def sent
  @sent
end

#status ⇒ Object

1-1 code



81
82
83
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 81

def status
  @status
end

#statusReason ⇒ Object

0-1 CodeableConcept



82
83
84
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 82

def statusReason
  @statusReason
end

#subject ⇒ Object

0-1 Reference(Patient|Group)



86
87
88
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 86

def subject
  @subject
end

#text ⇒ Object

0-1 Narrative



71
72
73
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 71

def text
  @text
end

#topic ⇒ Object

0-1 CodeableConcept



87
88
89
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 87

def topic
  @topic
end

Instance Method Details

#resourceType ⇒ Object 



98
99
100
 
# File 'lib/fhir_models/r5/generated/resources/Communication.rb', line 98

def resourceType
  'Communication'
end