Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Communication

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

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

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 about as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "about", XMLPROJECTION = "ELEMENT");
Reference

Resources that pertain to this communication.

Any FHIR4 Resource may be indicated by this Reference

Property methods: aboutBuildValueArray(), aboutCollectionToDisplay(), aboutCollectionToOdbc(), aboutDisplayToCollection(), aboutGet(), aboutGetObject(), aboutGetObjectId(), aboutGetSwizzled(), aboutIsValid(), aboutOdbcToCollection(), aboutSet(), aboutSetObject(), aboutSetObjectId()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Request fulfilled by this communication.

Any FHIR4 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Message category.

any FHIR4 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 encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter created as part of.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.DTL.vR4.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 inResponseTo as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "inResponseTo", XMLPROJECTION = "ELEMENT");
Reference

Reply to.

Communication

Property methods: inResponseToBuildValueArray(), inResponseToCollectionToDisplay(), inResponseToCollectionToOdbc(), inResponseToDisplayToCollection(), inResponseToGet(), inResponseToGetObject(), inResponseToGetObjectId(), inResponseToGetSwizzled(), inResponseToIsValid(), inResponseToOdbcToCollection(), inResponseToSet(), inResponseToSetObject(), inResponseToSetObjectId()
property instantiatesCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
canonical

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property medium as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "medium", XMLPROJECTION = "ELEMENT");
CodeableConcept

A channel of communication.

any FHIR4 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 note as list of HS.FHIR.DTL.vR4.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.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of this action.

Any FHIR4 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.vR4.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 priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

request-priority|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-priority|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Indication for message.

any FHIR4 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.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why was communication done?

Condition | Observation | DiagnosticReport | DocumentReference

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.vR4.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");
Reference

Message recipient.

Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService

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

Message sender.

Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService

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 | not-done | on-hold | stopped | completed | entered-in-error | unknown

event-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend event-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

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

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Focus of message.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property topic as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
CodeableConcept

Description of the purpose/content.

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

Property methods: topicGet(), topicGetSwizzled(), topicIsValid(), topicNewObject(), topicSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab