Skip to main content

HS.FHIRModel.R4.Communication

class HS.FHIRModel.R4.Communication extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Communication generated class schema
*****************************************
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_COMMUNICATION;
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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _received as HS.FHIRModel.R4.Element;
Extensions for received
Property methods: _receivedGet(), _receivedGetSwizzled(), _receivedIsValid(), _receivedNewObject(), _receivedSet()
property _sent as HS.FHIRModel.R4.Element;
Extensions for sent
Property methods: _sentGet(), _sentGetSwizzled(), _sentIsValid(), _sentNewObject(), _sentSet()
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 and to which this communication should be associated.
Property methods: aboutGet(), aboutGetSwizzled(), aboutIsValid(), aboutNewObject(), aboutSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
An order, proposal or plan fulfilled in whole or in part by this Communication.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
The type of message conveyed 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 encounter as HS.FHIRModel.R4.Reference;
The Encounter during which this Communication 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 identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business identifiers assigned to this communication 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 inResponseTo as HS.FHIRModel.R4.SeqOfReference;
Prior communication that this communication is in response to.
Property methods: inResponseToGet(), inResponseToGetSwizzled(), inResponseToIsValid(), inResponseToNewObject(), inResponseToSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
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()
Additional notes or commentary about the communication by the sender, receiver or other interested parties.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
Part of this action.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
Text, attachment(s), or resource(s) that was communicated to the recipient.
Property methods: payloadGet(), payloadGetSwizzled(), payloadIsValid(), payloadNewObject(), payloadSet()
property priority as %String;
Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The reason or justification for the communication.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates another resource whose existence justifies this communication.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property received as %String;
The time when this communication arrived at the destination.
Property methods: receivedDisplayToLogical(), receivedGet(), receivedIsValid(), receivedLogicalToDisplay(), receivedLogicalToOdbc(), receivedNormalize(), receivedSet()
property recipient as HS.FHIRModel.R4.SeqOfReference;
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
property resourceType as %String [ InitialExpression = "Communication" , Required ];
This is a Communication 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 was the source of the communication.
Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property sent as %String;
The time when this communication was sent.
Property methods: sentDisplayToLogical(), sentGet(), sentIsValid(), sentLogicalToDisplay(), sentLogicalToOdbc(), sentNormalize(), sentSet()
property status as %String;
The status of the transmission.
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 Communication.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference;
The patient or group that was the focus of this communication.
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()
property topic as HS.FHIRModel.R4.CodeableConcept;
Description of the purpose/content, similar to a subject line in an email.
Property methods: topicGet(), topicGetSwizzled(), topicIsValid(), topicNewObject(), topicSet()

Methods

method IncludeAbout()
method IncludeBasedOn()
method IncludeCategory()
method IncludeContained()
method IncludeEncounter()
method IncludeExtension()
method IncludeIdentifier()
method IncludeInResponseTo()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeMedium()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePartOf()
method IncludePayload()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRecipient()
method IncludeSender()
method IncludeStatusReason()
method IncludeSubject()
method IncludeText()
method IncludeTopic()
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