Class: FHIR::R5::CommunicationRequest

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

Defined Under Namespace

Classes: Payload

Constant Summary collapse

MULTIPLE_TYPES = 
{
  'occurrence' => ['dateTime', 'Period']
}
SEARCH_PARAMS = 
['authored', 'based-on', 'category', 'encounter', 'group-identifier', 'identifier', 'information-provider', 'medium', 'occurrence', 'patient', 'priority', 'recipient', 'replaces', 'requester', 'status', 'subject']
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'CommunicationRequest.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'CommunicationRequest.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'CommunicationRequest.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'CommunicationRequest.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'=>'CommunicationRequest.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'CommunicationRequest.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'CommunicationRequest.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'CommunicationRequest.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'identifier' => {'type'=>'Identifier', 'path'=>'CommunicationRequest.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'basedOn' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'CommunicationRequest.basedOn', 'min'=>0, 'max'=>Float::INFINITY},
  'replaces' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/CommunicationRequest'], 'type'=>'Reference', 'path'=>'CommunicationRequest.replaces', 'min'=>0, 'max'=>Float::INFINITY},
  'groupIdentifier' => {'type'=>'Identifier', 'path'=>'CommunicationRequest.groupIdentifier', 'min'=>0, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/request-status'=>['draft', 'active', 'on-hold', 'revoked', 'completed', 'entered-in-error', 'unknown']}, 'type'=>'code', 'path'=>'CommunicationRequest.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/request-status'}},
  'statusReason' => {'valid_codes'=>{'http://snomed.info/sct'=>['281323002', '397709008', '105480006', '719500002', '445060000', '704273008', '704274002', '704458005', '704275001', '704276000', '704277009', '310376006', '414859005', '416409005', '416308001', '737038009', '713835001', '398227009']}, 'type'=>'CodeableConcept', 'path'=>'CommunicationRequest.statusReason', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/communication-request-status-reason'}},
  'intent' => {'valid_codes'=>{'http://hl7.org/fhir/request-intent'=>['proposal', 'plan', 'directive', 'order', 'original-order', 'reflex-order', 'filler-order', 'instance-order', 'option']}, 'type'=>'code', 'path'=>'CommunicationRequest.intent', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/request-intent'}},
  'category' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/communication-category'=>['alert', 'notification', 'reminder', 'instruction']}, 'type'=>'CodeableConcept', 'path'=>'CommunicationRequest.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'=>'CommunicationRequest.priority', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/request-priority'}},
  'doNotPerform' => {'type'=>'boolean', 'path'=>'CommunicationRequest.doNotPerform', 'min'=>0, 'max'=>1},
  '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'=>'CommunicationRequest.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'=>'CommunicationRequest.subject', 'min'=>0, 'max'=>1},
  'about' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Resource'], 'type'=>'Reference', 'path'=>'CommunicationRequest.about', 'min'=>0, 'max'=>Float::INFINITY},
  'encounter' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Encounter'], 'type'=>'Reference', 'path'=>'CommunicationRequest.encounter', 'min'=>0, 'max'=>1},
  'payload' => {'type'=>'CommunicationRequest::Payload', 'path'=>'CommunicationRequest.payload', 'min'=>0, 'max'=>Float::INFINITY},
  'occurrenceDateTime' => {'type'=>'dateTime', 'path'=>'CommunicationRequest.occurrence[x]', 'min'=>0, 'max'=>1},
  'occurrencePeriod' => {'type'=>'Period', 'path'=>'CommunicationRequest.occurrence[x]', 'min'=>0, 'max'=>1},
  'authoredOn' => {'type'=>'dateTime', 'path'=>'CommunicationRequest.authoredOn', 'min'=>0, 'max'=>1},
  'requester' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Device'], 'type'=>'Reference', 'path'=>'CommunicationRequest.requester', 'min'=>0, 'max'=>1},
  'recipient' => {'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/Group', 'http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Endpoint'], 'type'=>'Reference', 'path'=>'CommunicationRequest.recipient', 'min'=>0, 'max'=>Float::INFINITY},
  'informationProvider' => {'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'], 'type'=>'Reference', 'path'=>'CommunicationRequest.informationProvider', 'min'=>0, 'max'=>Float::INFINITY},
  'reason' => {'type'=>'CodeableReference', 'path'=>'CommunicationRequest.reason', 'min'=>0, 'max'=>Float::INFINITY},
  'note' => {'type'=>'Annotation', 'path'=>'CommunicationRequest.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) ]



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

def about
  @about
end

#authoredOn ⇒ Object

0-1 dateTime



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

def authoredOn
  @authoredOn
end

#basedOn ⇒ Object

0-* [ Reference(Resource) ]



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

def basedOn
  @basedOn
end

#category ⇒ Object

0-* [ CodeableConcept ]



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

def category
  @category
end

#contained ⇒ Object

0-* [ Resource ]



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

def contained
  @contained
end

#doNotPerform ⇒ Object

0-1 boolean



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

def doNotPerform
  @doNotPerform
end

#encounter ⇒ Object

0-1 Reference(Encounter)



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

def encounter
  @encounter
end

#extension ⇒ Object

0-* [ Extension ]



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

def extension
  @extension
end

#groupIdentifier ⇒ Object

0-1 Identifier



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

def groupIdentifier
  @groupIdentifier
end

#id ⇒ Object

0-1 id



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

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



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

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



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

def implicitRules
  @implicitRules
end

#informationProvider ⇒ Object

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



99
100
101
 
# File 'lib/fhir_models/r5/generated/resources/CommunicationRequest.rb', line 99

def informationProvider
  @informationProvider
end

#intent ⇒ Object

1-1 code



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

def intent
  @intent
end

#language ⇒ Object

0-1 code



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

def language
  @language
end

#medium ⇒ Object

0-* [ CodeableConcept ]



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

def medium
  @medium
end

#meta ⇒ Object

0-1 Meta



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

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



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

def modifierExtension
  @modifierExtension
end

#note ⇒ Object

0-* [ Annotation ]



101
102
103
 
# File 'lib/fhir_models/r5/generated/resources/CommunicationRequest.rb', line 101

def note
  @note
end

#occurrenceDateTime ⇒ Object

0-1 dateTime



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

def occurrenceDateTime
  @occurrenceDateTime
end

#occurrencePeriod ⇒ Object

0-1 Period



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

def occurrencePeriod
  @occurrencePeriod
end

#payload ⇒ Object

0-* [ CommunicationRequest::Payload ]



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

def payload
  @payload
end

#priority ⇒ Object

0-1 code



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

def priority
  @priority
end

#reason ⇒ Object

0-* [ CodeableReference ]



100
101
102
 
# File 'lib/fhir_models/r5/generated/resources/CommunicationRequest.rb', line 100

def reason
  @reason
end

#recipient ⇒ Object

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



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

def recipient
  @recipient
end

#replaces ⇒ Object

0-* [ Reference(CommunicationRequest) ]



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

def replaces
  @replaces
end

#requester ⇒ Object

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



97
98
99
 
# File 'lib/fhir_models/r5/generated/resources/CommunicationRequest.rb', line 97

def requester
  @requester
end

#status ⇒ Object

1-1 code



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

def status
  @status
end

#statusReason ⇒ Object

0-1 CodeableConcept



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

def statusReason
  @statusReason
end

#subject ⇒ Object

0-1 Reference(Patient|Group)



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

def subject
  @subject
end

#text ⇒ Object

0-1 Narrative



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

def text
  @text
end

Instance Method Details

#resourceType ⇒ Object 



103
104
105
 
# File 'lib/fhir_models/r5/generated/resources/CommunicationRequest.rb', line 103

def resourceType
  'CommunicationRequest'
end