Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.Communication extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

A record of information transmitted from a sender to a receiver.

Property Inventory


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 = Communication;
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.
parameter XMLTYPE = 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.


property category as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");

Message category.

any FHIR2 code from any ValueSet may be used.

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property encounter as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");

Encounter leading to message.


Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Unique identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property medium as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "medium", XMLPROJECTION = "ELEMENT");

A channel of communication.

any FHIR2 code may be used; v3-ParticipationMode shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: mediumBuildValueArray(), mediumCollectionToDisplay(), mediumCollectionToOdbc(), mediumDisplayToCollection(), mediumGet(), mediumGetObject(), mediumGetObjectId(), mediumGetSwizzled(), mediumIsValid(), mediumOdbcToCollection(), mediumSet(), mediumSetObject(), mediumSetObjectId()
property payload as list of HS.FHIR.DTL.vDSTU2.Model.Element.Communication.payload (XMLNAME = "payload", XMLPROJECTION = "ELEMENT");

Message payload.

Property methods: payloadBuildValueArray(), payloadCollectionToDisplay(), payloadCollectionToOdbc(), payloadDisplayToCollection(), payloadGet(), payloadGetObject(), payloadGetObjectId(), payloadGetSwizzled(), payloadIsValid(), payloadOdbcToCollection(), payloadSet(), payloadSetObject(), payloadSetObjectId()
property reason as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");

Indication for message.

any FHIR2 code from any ValueSet may be used.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property received as %String (MAXLEN = 1000000, XMLNAME = "received", XMLPROJECTION = "ATTRIBUTE");

When received.

Property methods: receivedDisplayToLogical(), receivedGet(), receivedIsValid(), receivedLogicalToDisplay(), receivedLogicalToOdbc(), receivedNormalize(), receivedSet()
property recipient as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");

Message recipient.

Device | Organization | Patient | Practitioner | RelatedPerson | Group

Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()
property requestDetail as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "requestDetail", XMLPROJECTION = "ELEMENT");

CommunicationRequest producing this message.


Property methods: requestDetailGet(), requestDetailGetSwizzled(), requestDetailIsValid(), requestDetailNewObject(), requestDetailSet()
property sender as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "sender", XMLPROJECTION = "ELEMENT");

Message sender.

Device | Organization | Patient | Practitioner | RelatedPerson

Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property sent as %String (MAXLEN = 1000000, XMLNAME = "sent", XMLPROJECTION = "ATTRIBUTE");

When sent.

Property methods: sentDisplayToLogical(), sentGet(), sentIsValid(), sentLogicalToDisplay(), sentLogicalToOdbc(), sentNormalize(), sentSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

in-progress | completed | suspended | rejected | failed

communication-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend communication-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Focus of message.


Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab