Skip to main content

HS.FHIR.vSTU3.Model.Resource.CommunicationRequest

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

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 = 1;
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 authoredOn as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "authoredOn", XMLPROJECTION = "ELEMENT");
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
Property methods: authoredOnGet(), authoredOnGetSwizzled(), authoredOnIsValid(), authoredOnNewObject(), authoredOnSet()
property basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
A plan or proposal that is fulfilled in whole or in part by this request.
Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property category as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
The type of message to be sent such as alert, notification, reminder, instruction, etc.
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The encounter or episode of care within which the communication request was created.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property groupIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");
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 list of HS.FHIR.vSTU3.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.vSTU3.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 note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Comments made about the request by the requester, sender, recipient, subject or other participants.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ELEMENT");
Property methods: occurrenceDateTimeGet(), occurrenceDateTimeGetSwizzled(), occurrenceDateTimeIsValid(), occurrenceDateTimeNewObject(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property payload as list of HS.FHIR.vSTU3.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.vSTU3.Model.Base.RequestPriority (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
Describes why the request is being made in coded or textual form.
Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Indicates another resource whose existence justifies this request.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property recipient as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");
The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()
property replaces as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
Completed or terminated request(s) whose function is taken by this new request.
Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property requester as HS.FHIR.vSTU3.Model.Resource.CommunicationRequest.Requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
The individual who initiated the request and has responsibility for its activation.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property sender as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "sender", XMLPROJECTION = "ELEMENT");
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.vSTU3.Model.Base.RequestStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of the proposal or order.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
The patient or group that is the focus of this communication request.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property topic as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
The resources which were related to producing this communication request.
Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()

Methods

deprecated method SetAuthoredOn(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 "authoredOn" property.
deprecated method SetBasedOn(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 "basedOn" property.
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.
Insert method for the "category" property.
deprecated method SetContext(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 "context" property.
deprecated method SetGroupIdentifier(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.
Set method for the "groupIdentifier" 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 SetOccurrenceDateTime(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 "occurrenceDateTime" property.
deprecated method SetOccurrencePeriod(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 "occurrencePeriod" property.
deprecated method SetPriority(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 "priority" property.
deprecated method SetReasonCode(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 "reasonCode" property.
deprecated method SetReasonReference(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 "reasonReference" 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 SetReplaces(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 "replaces" 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.
deprecated method SetTopic(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 "topic" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab