Skip to main content

Need Help Using Spok Knowledge?

Internet Explorer is not supported. Please reload in Chrome, Edge, Firefox, or Safari.
Spok

Event Tags in Spok Messenger

Tags are attributes associated with an Event that help describe its context. There are System Tags which are reserved for special use and help provide special functionality while executing an event action. Users can also define and use their own tags as desired to provide additional context to an event action.

Some tag values can be extracted from input sources. They can also be defined at a global, event or action level. Some system tags can be expanded to define values for sibling tags at runtime (i.e., expanding a location or patient context at runtime).

Event tags are also included within any outbound messages that are generated from event actions. They can be used in device templates to format what information is included within an alert and how it is formatted.

Below is a table of System Tags currently available within the application. These tags cannot be used as user-defined tags. User defined tags should use different names. Tags are case-insensitive.

Event Context Tags

Event Context

Use in extraction?

Description

Generated By

Notes

Min. Version

ea

No

Abbreviation for the event

Events

Configured by the user within the Event definition

5.0

el

No

Priority level for the event

Events

Configured by the user within the Event definition, numeric value.

5.0

em

No

Event message

Events

 

5.0

en

No

Full name of the event

Events

Configured by the user within the event

5.0

evt

No

Event trigger match

Events

The substring of the input message that matched the event trigger expression

5.0

rm

No

The original input message text that triggered the event

Events

This will be the original text message that was used to trigger the event.

5.0

 

Action Context Tags

Action Context

Use in extraction?

Description

Generated By

Notes

Min. Version

aa

No

Action abbreviation

Events

 

5.0

ab

No

Alert profile associated with the action

Events

Configured by the user within the event definition

5.0

act

No

Action trigger match

Events

The subtext from the original input message that matched the action’s trigger expression

5.0

actmsg

No

Activation message text

Events

Set based on the action tag context and the activation message expression configured by the user. The original input message is used if no expression is defined by the user.

5.0

clearmsg

No

Clear message text

Events

Set based on the action tag context and the clear message expression configured by the user. The original input message is used if no expression is defined by the user.

5.0

ae

No

Action callback extension

Events

 

5.0

ah

No

Action callback hunt group

Events

 

5.0

al

No

Action priority level

Events

Configured by the user within the event action definition, numeric value

5.0

allpins

No

Destination addresses

Events

Contains a list of all destination addresses provided by the original input source message (input protocol must have a destination address component)

5.0

am

No

Action message

Events

 

5.0

an

No

Full name of the Action

Events

Configured by the user within the action

5.0

et

No

Action trigger timestamp

Events

The application’s server time when the action was triggered.

5.0

 

Extraction Tags

Extraction Tags

Use in extraction?

Description

Generated By

Notes

Min. Version

pin

Yes

Recipient Local ID

User

Use this in an extraction expression to parse a destination address out of the inbound text message. This can be used if the input context does not include a destination address from the source module via protocol.

5.0

reset

Yes

Action reset trigger value

User

User can set this in an action’s extraction expression to trigger a reset action for activation types. Only exists at runtime in the context if the input message was identified as a reset message by matching this part of the extraction expression. Set to the subset of the original message that caused the message to be identified as a reset message.

5.0

 

Location Context Tags

Location Context

Use in extraction?

Description

Generated By

Notes

Min. Version

cei

No

Campus EMR Identifier

Events

Location hierarchy. This can be set by location configuration, or also expanded by the action processor when expanding location context.

5.15.1

fei

No

Facility EMR Identifier

Events

Location hierarchy. This can be set by location configuration, or also expanded by the action processor when expanding location context.

5.15.1

uei

No

Unit EMR Identifier

Events

Location hierarchy. This can be set by location configuration, or also expanded by the action processor when expanding location context.

5.15.1

rei

No

Room EMR Identifier

Events

Location hierarchy. This can be set by location configuration, or also expanded by the action processor when expanding location context.

5.15.1

bei

No

Bed EMR Identifier

Events

Location hierarchy. This can be set by location configuration, or also expanded by the action processor when expanding location context.

5.15.1

fi

Yes

Facility identifier

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

fn

No

Facility name

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

fa

No

Facility abbreviation

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

fh

No

Facility hunt group

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

fe

No

Facility extension

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ui

Yes

Unit identifier

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

un

No

Unit name

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ua

No

Unit abbreviation

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

uh

No

Unit hunt group

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ue

No

Unit extension

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ri

Yes

Room identifier

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

rn

No

Room name

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ra

No

Room abbreviation

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

rh

No

Room hunt group

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

re

No

Room extension

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

bi

Yes

Bed identifier

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

bn

No

Bed name

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ba

No

Bed abbreviation

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

bh

No

Bed hunt group

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

be

No

Bed extension

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ci

Yes

Campus identifier

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

cn

No

Campus name

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ca

No

Campus abbreviation

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ch

No

Campus hunt group

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

ce

No

Campus extension

Events

Location hierarchy. This can be set by user default tags, extracted from an input message or also expanded by the action processor when expanding location context.

5.0

rawmessage

No Raw message content. Spectralink Web Contains the text sent for the dispatched message to the gateway, including metadata like callback information 5.9
fromuser No User that originated the message. Spectralink Web This tag is filled only when the message is sent from a manual messaging source in the application. Otherwise it is blank. 5.9
callbacknumber No Callback number embedded in the message. Spectralink Web   5.9
messageid No Unique Message identifier used with the Spectralink Web message. Spectralink Web   5.9
messagecontent No Gateway message text with all metadata removed Spectralink Web   5.9

 

 

Patient Context Tags

Patient Context

Use in extraction?

Description

Generated By

Notes

Min. Version

patientid

Yes

Patient identifier (i.e., medical record number)

Events

Can extract this from source message to define patient or could be populated by events if patient context can be resolved

5.10

patient_firstname

No

First name of patient

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_lastname

No

Last name of patient

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_middlename

No

Middle name of patient

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_suffix

No

The patient’s name suffix

Events

i.e., “Jr.”

5.10

patient_gender

No

The patient’s gender code

Events

i.e., “M”, “F”

5.10

patient_dob

No

Patient’s date of birth

Events

The date/time will be localized based on the culture that is set within the Patient Repository Service’s server.

5.10

patient_class

No

General Type of patient

Events

Patient class must be “I” to indicate Inpatient.

5.10

patient_type

No

Specific type of patient

Events

i.e., “IPE”

5.10

patient_accountnumber

No

Patient visit number

Events

i.e., “10010101”

5.10

patient_admitreason

No

Admit reason for Patient

Events

i.e., “Appendicitis”

 

patient_location_campusid

No

Campus identifier for patient’s assigned location

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_location_facilityid

No

Facility identifier for patient’s assigned location

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_location_unitid

No

Unit identifier for patient’s assigned location

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_location_roomid

No

Room identifier for patient’s assigned location

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_location_bedid

No

Bed identifier for patient’s assigned location

Events

If patientid id defined and matches a patient record in the Patient Repository then this will be populated from the repository record.

5.10

patient_diagnoses

No

Set of diagnoses associated with the patient

 

Expressed in text form where each diagnosis is separated with a newline delimiter

5.10

patient_allergies

No

Set of allergies associated with the patient

 

Expressed in text form where each allergy is separated with a newline delimiter

5.10

patient_observations

No

Set of observations associated with the patient

 

Expressed in text form where each observation is separated with a newline delimiter

5.10

 

IHE Patient Care Device Tags

 

RTLS Location Service Tags

Tag

Use in Extraction?

Description

Generated By

Notes

Minimum Version

rtls_device_name

No

RTLS System's human readable name for the device

Ekahau RTLS Gateway

 

5.15

rtls_device_mac

No

RTLS System's device mac address

Ekahau RTLS Gateway

 

5.15

rtls_zone_id

No

RTLS System's zone identifier

Ekahau RTLS Gateway

 

5.15

rtls_zone_name

No

RTLS System's human readable name for zone the device is located in

 

Ekahau RTLS Gateway

 

5.15

rtls_update_reason

No

RTLS System's reason for update

Ekahau RTLS Gateway

 

5.15

rtls_event_status

No

RTLS System's event's current status

Ekahau RTLS Gateway

 

5.15