Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.vDSTU2.Model.Resource.CommunicationRequest

deprecated class HS.FHIR.vDSTU2.Model.Resource.CommunicationRequest extends HS.FHIR.vDSTU2.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = CommunicationRequest;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 0;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property category as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "category");
The type of message to be sent such as alert, notification, reminder, instruction, etc.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property encounter as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "encounter");
The encounter within which the communication request was created.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.vDSTU2.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property medium as list of HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "medium", XMLPROJECTION = "ELEMENT");
A channel that was used for this communication (e.g. email, fax).
Property methods: mediumBuildValueArray(), mediumCollectionToDisplay(), mediumCollectionToOdbc(), mediumDisplayToCollection(), mediumGet(), mediumGetObject(), mediumGetObjectId(), mediumGetSwizzled(), mediumIsValid(), mediumOdbcToCollection(), mediumSet(), mediumSetObject(), mediumSetObjectId()
property payload as list of HS.FHIR.vDSTU2.Model.Resource.CommunicationRequest.Payload (XMLNAME = "payload", XMLPROJECTION = "ELEMENT");
Text, attachment(s), or resource(s) to be communicated to the recipient.
Property methods: payloadBuildValueArray(), payloadCollectionToDisplay(), payloadCollectionToOdbc(), payloadDisplayToCollection(), payloadGet(), payloadGetObject(), payloadGetObjectId(), payloadGetSwizzled(), payloadIsValid(), payloadOdbcToCollection(), payloadSet(), payloadSetObject(), payloadSetObjectId()
property priority as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "priority");
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as list of HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
The reason or justification for the communication request.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property recipient as list of HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");
The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.
Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()
property requestedOn as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "requestedOn");
The time when the request was made.
Property methods: requestedOnGet(), requestedOnGetSwizzled(), requestedOnIsValid(), requestedOnNewObject(), requestedOnSet()
property requester as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "requester");
The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property scheduledDateTime as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "scheduledDateTime");
Property methods: scheduledDateTimeGet(), scheduledDateTimeGetSwizzled(), scheduledDateTimeIsValid(), scheduledDateTimeNewObject(), scheduledDateTimeSet()
property scheduledPeriod as HS.FHIR.vDSTU2.Model.Base.Period (XMLNAME = "scheduledPeriod");
Property methods: scheduledPeriodGet(), scheduledPeriodGetSwizzled(), scheduledPeriodIsValid(), scheduledPeriodNewObject(), scheduledPeriodSet()
property sender as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "sender");
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 HS.FHIR.vDSTU2.Model.Base.CommunicationRequestStatus (XMLNAME = "status");
The status of the proposal or order.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "subject");
The patient who is the focus of this communication request.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Methods

deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "category" property.
deprecated method SetEncounter(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "encounter" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetMedium(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "medium" property.
deprecated method SetPriority(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "priority" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetRecipient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "recipient" property.
deprecated method SetRequestedOn(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requestedOn" property.
deprecated method SetRequester(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requester" property.
deprecated method SetScheduledDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "scheduledDateTime" property.
deprecated method SetScheduledPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "scheduledPeriod" property.
deprecated method SetSender(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "sender" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab