Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (21)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.CommunicationRequest

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

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.

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 = 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 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 = CommunicationRequest;

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 authoredOn as %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");

dateTime

When request transitioned to being actionable.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()

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

Reference

Fulfills plan or proposal.

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 groupIdentifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");

Identifier

Composite request this is part of.

Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()

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 note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Annotation

Comments made about communication request.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()

property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");

dateTime

When scheduled.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()

property occurrencePeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");

Period

When scheduled.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()

property payload as list of HS.FHIR.DTL.vSTU3.Model.Element.CommunicationRequest.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

Message urgency.

request-priority is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-priority 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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");

CodeableConcept

Why is communication needed?

any FHIR3 code may be used; v3-ActReason 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 is communication needed?

Condition | Observation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()

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

Reference

Message recipient.

Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()

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

Reference

Request(s) replaced by this request.

CommunicationRequest

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()

property requester as HS.FHIR.DTL.vSTU3.Model.Element.CommunicationRequest.requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");

BackboneElement

Who/what is requesting service.

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()

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 status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

code

request-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-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

Feedback