Class: FHIR::CommunicationRequest
- Defined in:
- lib/fhir_models/fhir/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', 'medium', 'occurrence', 'patient', 'priority', 'recipient', 'replaces', 'requester', 'sender', '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' => {'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'=>'CommunicationRequest.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/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|4.0.0'}}, 'statusReason' => {'type'=>'CodeableConcept', 'path'=>'CommunicationRequest.statusReason', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example'}}, '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|4.0.0'}}, 'doNotPerform' => {'type'=>'boolean', 'path'=>'CommunicationRequest.doNotPerform', 'min'=>0, 'max'=>1}, 'medium' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ParticipationMode'=>['ELECTRONIC', 'PHYSICAL', 'REMOTE', 'VERBAL', 'DICTATE', 'FACE', 'PHONE', 'VIDEOCONF', 'WRITTEN', 'FAXWRIT', 'HANDWRIT', 'MAILWRIT', 'ONLINEWRIT', 'EMAILWRIT', 'TYPEWRIT']}, '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'], 'type'=>'Reference', 'path'=>'CommunicationRequest.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'], 'type'=>'Reference', 'path'=>'CommunicationRequest.sender', 'min'=>0, 'max'=>1}, 'reasonCode' => {'valid_codes'=>{'http://terminology.hl7.org/CodeSystem/v3-ActReason'=>['ACCREQNA', 'FLRCNV', 'MEDNEC', 'PAT', 'COVSUS', 'DECSD', 'REGERR', 'AGE', 'CRIME', 'DIS', 'EMPLOY', 'FINAN', 'HEALTH', 'MULTI', 'PNC', 'STATUTORY', 'VEHIC', 'WORK', 'OVRER', 'OVRINCOMP', 'OVRPJ', 'OVRPS', 'OVRTPS', 'PurposeOfUse', 'HMARKT', 'HOPERAT', 'CAREMGT', 'DONAT', 'FRAUD', 'GOV', 'HACCRED', 'HCOMPL', 'HDECD', 'HDIRECT', 'HDM', 'HLEGAL', 'HOUTCOMS', 'HPRGRP', 'HQUALIMP', 'HSYSADMIN', 'LABELING', 'METAMGT', 'MEMADMIN', 'MILCDM', 'PATADMIN', 'PATSFTY', 'PERFMSR', 'RECORDMGT', 'SYSDEV', 'HTEST', 'TRAIN', 'HPAYMT', 'CLMATTCH', 'COVAUTH', 'COVERAGE', 'ELIGDTRM', 'ELIGVER', 'ENROLLM', 'MILDCRG', 'REMITADV', 'HRESCH', 'BIORCH', 'CLINTRCH', 'CLINTRCHNPC', 'CLINTRCHPC', 'PRECLINTRCH', 'DSRCH', 'POARCH', 'TRANSRCH', 'PATRQT', 'FAMRQT', 'PWATRNY', 'SUPNWK', 'PUBHLTH', 'DISASTER', 'THREAT', 'TREAT', 'CLINTRL', 'COC', 'ETREAT', 'BTG', 'ERTREAT', 'POPHLTH', 'MARKT', 'OPERAT', 'LEGAL', 'ACCRED', 'COMPL', 'ENADMIN', 'OUTCOMS', 'PRGRPT', 'QUALIMP', 'SYSADMN', 'PAYMT', 'RESCH', 'SRVC', '_ActInvalidReason', 'ADVSTORAGE', 'COLDCHNBRK', 'EXPLOT', 'OUTSIDESCHED', 'PRODRECALL', 'INCCOVPTY', 'INCINVOICE', 'INCPOLICY', 'INCPROV', 'IMMUNE', 'MEDPREC', 'OSTOCK', 'PATOBJ', 'PHILISOP', 'RELIG', 'VACEFF', 'VACSAF', 'FRR01', 'FRR02', 'FRR03', 'FRR04', 'FRR05', 'FRR06', 'RET', 'SCH', 'TRM', 'UNS', 'NPT', 'PPT', 'UPT', 'ALTCHOICE', 'CLARIF', 'DRUGHIGH', 'HOSPADM', 'LABINT', 'NON-AVAIL', 'PREG', 'SALG', 'SDDI', 'SDUPTHER', 'SINTOL', 'SURG', 'WASHOUT', '_ControlActNullificationReasonCode', 'ALTD', 'EIE', 'NORECMTCH', 'INRQSTATE', 'NOMATCH', 'NOPRODMTCH', 'NOSERMTCH', 'NOVERMTCH', 'NOPERM', 'NOUSERPERM', 'NOAGNTPERM', 'NOUSRPERM', 'WRNGVER', 'DISCONT', 'INEFFECT', 'MONIT', 'NOREQ', 'NOTCOVER', 'PREFUS', 'RECALL', 'REPLACE', 'DOSECHG', 'REPLACEFIX', 'UNABLE', 'HOLDDONE', 'HOLDINAP', 'ADMINERROR', 'CLINMOD', '_PharmacySupplyEventAbortReason', 'CONTRA', 'FOABORT', 'FOSUSP', 'NOPICK', 'PATDEC', 'QUANTCHG', 'FLRSTCK', 'LTC', 'OFFICE', 'PHARM', 'PROG', 'ALREADYRX', 'FAMPHYS', 'MODIFY', 'NEEDAPMT', 'NOTAVAIL', 'NOTPAT', 'ONHOLD', 'PRNA', 'STOPMED', 'TOOEARLY', 'IMPROV', 'INTOL', 'NEWSTR', 'NEWTHER', 'CHGDATA', 'FIXDATA', 'MDATA', 'NEWDATA', 'UMDATA', 'ADMREV', 'PATCAR', 'PATREQ', 'PRCREV', 'REGUL', 'RSRCH', 'VALIDATION', '_PharmacySupplyRequestFulfillerRevisionRefusalReasonCode', 'LOCKED', 'UNKWNTARGET', 'BLK', 'DEC', 'FIN', 'MED', 'MTG', 'PHY', '_StatusRevisionRefusalReasonCode', 'FILLED', '_SubstanceAdministrationPermissionRefusalReasonCode', 'PATINELIG', 'PROTUNMET', 'PROVUNAUTH', 'ALGINT', 'COMPCON', 'THERCHAR', 'TRIAL', 'CT', 'FP', 'OS', 'RR', 'ER', 'RQ', 'BONUS', 'CHD', 'DEP', 'ECH', 'EDU', 'EMP', 'ESP', 'FAM', 'IND', 'INVOICE', 'PROA', 'RECOV', 'RETRO', 'SPC', 'SPO', 'TRAN']}, 'type'=>'CodeableConcept', 'path'=>'CommunicationRequest.reasonCode', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'example', 'uri'=>'http://terminology.hl7.org/ValueSet/v3-ActReason'}}, 'reasonReference' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/Observation', 'http://hl7.org/fhir/StructureDefinition/DiagnosticReport', 'http://hl7.org/fhir/StructureDefinition/DocumentReference'], 'type'=>'Reference', 'path'=>'CommunicationRequest.reasonReference', 'min'=>0, 'max'=>Float::INFINITY}, 'note' => {'type'=>'Annotation', 'path'=>'CommunicationRequest.note', 'min'=>0, 'max'=>Float::INFINITY} }
Instance Attribute Summary collapse
-
#about ⇒ Object
0-* [ Reference(Resource) ].
-
#authoredOn ⇒ Object
0-1 dateTime.
-
#basedOn ⇒ Object
0-* [ Reference(Resource) ].
-
#category ⇒ Object
0-* [ CodeableConcept ].
-
#contained ⇒ Object
0-* [ Resource ].
-
#doNotPerform ⇒ Object
0-1 boolean.
-
#encounter ⇒ Object
0-1 Reference(Encounter).
-
#extension ⇒ Object
0-* [ Extension ].
-
#groupIdentifier ⇒ Object
0-1 Identifier.
-
#id ⇒ Object
0-1 id.
-
#identifier ⇒ Object
0-* [ Identifier ].
-
#implicitRules ⇒ Object
0-1 uri.
-
#language ⇒ Object
0-1 code.
-
#medium ⇒ Object
0-* [ CodeableConcept ].
-
#meta ⇒ Object
0-1 Meta.
-
#modifierExtension ⇒ Object
0-* [ Extension ].
-
#note ⇒ Object
0-* [ Annotation ].
-
#occurrenceDateTime ⇒ Object
0-1 dateTime.
-
#occurrencePeriod ⇒ Object
0-1 Period.
-
#payload ⇒ Object
0-* [ CommunicationRequest::Payload ].
-
#priority ⇒ Object
0-1 code.
-
#reasonCode ⇒ Object
0-* [ CodeableConcept ].
-
#reasonReference ⇒ Object
0-* [ Reference(Condition|Observation|DiagnosticReport|DocumentReference) ].
-
#recipient ⇒ Object
0-* [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) ].
-
#replaces ⇒ Object
0-* [ Reference(CommunicationRequest) ].
-
#requester ⇒ Object
0-1 Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device).
-
#sender ⇒ Object
0-1 Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|HealthcareService).
-
#status ⇒ Object
1-1 code.
-
#statusReason ⇒ Object
0-1 CodeableConcept.
-
#subject ⇒ Object
0-1 Reference(Patient|Group).
-
#text ⇒ Object
0-1 Narrative.
Instance Method Summary collapse
Methods included from Xml
from_xml, #to_xml, valid?, validate
Methods included from Deprecate
Methods included from Json
Methods included from Hashable
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
#about ⇒ Object
0-* [ Reference(Resource) ]
89 90 91 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 89 def about @about end |
#authoredOn ⇒ Object
0-1 dateTime
94 95 96 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 94 def @authoredOn end |
#basedOn ⇒ Object
0-* [ Reference(Resource) ]
79 80 81 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 79 def basedOn @basedOn end |
#category ⇒ Object
0-* [ CodeableConcept ]
84 85 86 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 84 def category @category end |
#contained ⇒ Object
0-* [ Resource ]
75 76 77 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 75 def contained @contained end |
#doNotPerform ⇒ Object
0-1 boolean
86 87 88 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 86 def doNotPerform @doNotPerform end |
#encounter ⇒ Object
0-1 Reference(Encounter)
90 91 92 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 90 def encounter @encounter end |
#extension ⇒ Object
0-* [ Extension ]
76 77 78 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 76 def extension @extension end |
#groupIdentifier ⇒ Object
0-1 Identifier
81 82 83 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 81 def groupIdentifier @groupIdentifier end |
#id ⇒ Object
0-1 id
70 71 72 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 70 def id @id end |
#identifier ⇒ Object
0-* [ Identifier ]
78 79 80 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 78 def identifier @identifier end |
#implicitRules ⇒ Object
0-1 uri
72 73 74 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 72 def implicitRules @implicitRules end |
#language ⇒ Object
0-1 code
73 74 75 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 73 def language @language end |
#medium ⇒ Object
0-* [ CodeableConcept ]
87 88 89 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 87 def medium @medium end |
#meta ⇒ Object
0-1 Meta
71 72 73 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 71 def @meta end |
#modifierExtension ⇒ Object
0-* [ Extension ]
77 78 79 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 77 def modifierExtension @modifierExtension end |
#note ⇒ Object
0-* [ Annotation ]
100 101 102 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 100 def note @note end |
#occurrenceDateTime ⇒ Object
0-1 dateTime
92 93 94 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 92 def occurrenceDateTime @occurrenceDateTime end |
#occurrencePeriod ⇒ Object
0-1 Period
93 94 95 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 93 def occurrencePeriod @occurrencePeriod end |
#payload ⇒ Object
0-* [ CommunicationRequest::Payload ]
91 92 93 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 91 def payload @payload end |
#priority ⇒ Object
0-1 code
85 86 87 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 85 def priority @priority end |
#reasonCode ⇒ Object
0-* [ CodeableConcept ]
98 99 100 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 98 def reasonCode @reasonCode end |
#reasonReference ⇒ Object
0-* [ Reference(Condition|Observation|DiagnosticReport|DocumentReference) ]
99 100 101 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 99 def reasonReference @reasonReference end |
#recipient ⇒ Object
0-* [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) ]
96 97 98 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 96 def recipient @recipient end |
#replaces ⇒ Object
0-* [ Reference(CommunicationRequest) ]
80 81 82 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 80 def replaces @replaces end |
#requester ⇒ Object
0-1 Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device)
95 96 97 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 95 def requester @requester end |
#sender ⇒ Object
0-1 Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|HealthcareService)
97 98 99 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 97 def sender @sender end |
#status ⇒ Object
1-1 code
82 83 84 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 82 def status @status end |
#statusReason ⇒ Object
0-1 CodeableConcept
83 84 85 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 83 def statusReason @statusReason end |
#subject ⇒ Object
0-1 Reference(Patient|Group)
88 89 90 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 88 def subject @subject end |
#text ⇒ Object
0-1 Narrative
74 75 76 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 74 def text @text end |
Instance Method Details
#resourceType ⇒ Object
102 103 104 |
# File 'lib/fhir_models/fhir/resources/CommunicationRequest.rb', line 102 def resourceType 'CommunicationRequest' end |