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

HS.FHIR.DTL.vSTU3.Model.Resource.Communication

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

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

Property 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 = 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 XMLPROJECTION = ELEMENT;
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.

Properties

property basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Request fulfilled by this communication.

Any FHIR3 Resource may be indicated by this Reference

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property category as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Message category.

any FHIR3 code may be used; communication-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter or episode leading to message.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Reference

Instantiates protocol or definition.

PlanDefinition | ActivityDefinition

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "medium", XMLPROJECTION = "ELEMENT");
CodeableConcept

A channel of communication.

any FHIR3 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 notDone as %Boolean (XMLNAME = "notDone", XMLPROJECTION = "ATTRIBUTE");
boolean

Communication did not occur.

Property methods: notDoneDisplayToLogical(), notDoneGet(), notDoneIsValid(), notDoneLogicalToDisplay(), notDoneLogicalToXSD(), notDoneNormalize(), notDoneSet(), notDoneXSDToLogical()
property notDoneReason as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "notDoneReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why communication did not occur.

any FHIR3 code may be used; communication-not-done-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments made about the communication.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of this action.

Any FHIR3 Resource may be indicated by this Reference

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property payload as list of HS.FHIR.DTL.vSTU3.Model.Element.Communication.payload (XMLNAME = "payload", XMLPROJECTION = "ELEMENT");
BackboneElement

Message payload.

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

Indication for message.

any FHIR3 code may be used; clinical-findings shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why was communication done?

Condition | Observation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property received as %String (MAXLEN = 1000000, XMLNAME = "received", XMLPROJECTION = "ATTRIBUTE");
dateTime

When received.

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

Message recipient.

Device | Organization | Patient | Practitioner | RelatedPerson | Group

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

Message sender.

Device | Organization | Patient | Practitioner | RelatedPerson

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

When sent.

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

preparation | in-progress | suspended | aborted | completed | entered-in-error

event-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend event-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.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Focus of message.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property topic as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
Reference

Focal resources.

Any FHIR3 Resource may be indicated by this Reference

Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab