Skip to main content

HS.FHIRModel.R4.CommunicationRequest

class HS.FHIRModel.R4.CommunicationRequest extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CommunicationRequest generated class schema
*****************************************
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_COMMUNICATIONREQUEST;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _authoredOn as HS.FHIRModel.R4.Element;
Extensions for authoredOn
Property methods: _authoredOnGet(), _authoredOnGetSwizzled(), _authoredOnIsValid(), _authoredOnNewObject(), _authoredOnSet()
property _doNotPerform as HS.FHIRModel.R4.Element;
Extensions for doNotPerform
Property methods: _doNotPerformGet(), _doNotPerformGetSwizzled(), _doNotPerformIsValid(), _doNotPerformNewObject(), _doNotPerformSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _occurrenceDateTime as HS.FHIRModel.R4.Element;
Extensions for occurrenceDateTime
Property methods: _occurrenceDateTimeGet(), _occurrenceDateTimeGetSwizzled(), _occurrenceDateTimeIsValid(), _occurrenceDateTimeNewObject(), _occurrenceDateTimeSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property about as HS.FHIRModel.R4.SeqOfReference;
Other resources that pertain to this communication request and to which this communication request should be associated.
Property methods: aboutGet(), aboutGetSwizzled(), aboutIsValid(), aboutNewObject(), aboutSet()
property authoredOn as %String;
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A plan or proposal that is fulfilled in whole or in part by this request.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
The type of message to be sent such as alert, notification, reminder, instruction, etc.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property doNotPerform as %Boolean;
If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property encounter as HS.FHIRModel.R4.Reference;
The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property groupIdentifier as HS.FHIRModel.R4.Identifier;
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
A channel that was used for this communication (e.g. email, fax).
Property methods: mediumGet(), mediumGetSwizzled(), mediumIsValid(), mediumNewObject(), mediumSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Comments made about the request by the requester, sender, recipient, subject or other participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property occurrenceDateTime as %String;
The time when this communication is to occur.
Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIRModel.R4.Period;
The time when this communication is to occur.
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
Text, attachment(s), or resource(s) to be communicated to the recipient.
Property methods: payloadGet(), payloadGetSwizzled(), payloadIsValid(), payloadNewObject(), payloadSet()
property priority as %String;
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Describes why the request is being made in coded or textual form.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates another resource whose existence justifies this request.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property recipient as HS.FHIRModel.R4.SeqOfReference;
The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
property replaces as HS.FHIRModel.R4.SeqOfReference;
Completed or terminated request(s) whose function is taken by this new request.
Property methods: replacesGet(), replacesGetSwizzled(), replacesIsValid(), replacesNewObject(), replacesSet()
property requester as HS.FHIRModel.R4.Reference;
The device, individual, or organization who initiated the request and has responsibility for its activation.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property resourceType as %String [ InitialExpression = "CommunicationRequest" , Required ];
This is a CommunicationRequest resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property sender as HS.FHIRModel.R4.Reference;
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property status as %String;
The status of the proposal or order.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
Captures the reason for the current state of the CommunicationRequest.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference;
The patient or group that is the focus of this communication request.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAbout()
method IncludeBasedOn()
method IncludeCategory()
method IncludeContained()
method IncludeEncounter()
method IncludeExtension()
method IncludeGroupIdentifier()
method IncludeIdentifier()
method IncludeMedium()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOccurrencePeriod()
method IncludePayload()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRecipient()
method IncludeReplaces()
method IncludeRequester()
method IncludeSender()
method IncludeStatusReason()
method IncludeSubject()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab