Real Time Location Services Implementation Guide
1.0.0-ballot2 - STU 1 - Ballot 2 International flag

This page is part of the Real Time Location Services Implementation Guide (v1.0.0-ballot2: STU 1.0 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

OperationDefinition: RTLS Auxiliary Function Operation (Experimental)

Official URL: http://hl7.org/fhir/uv/rtls/OperationDefinition/rtlsAuxiliaryFunction Version: 1.0.0-ballot2
Standards status: Informative Computable Name: RTLSAuxiliaryFunction

RTLS Auxiliary Function

This operation provides parameters for RTLS messaging functions.

URL: [base]/$$auxiliary-function

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INevent1..1Coding

The event contains the type of message that points to which Auxiliary Function is being performed. In the context of staff duress, this would contain the value of staff-duress.

INlocation1..1Location

The location represents a physical location in which the Auxiliary Function is going to be referencing.

INdevice1..1Device

The device represents a physical device which will create the Auxiliary Function through some physical action.

INtimestamp1..1instant

The timestamp represents the instant the Auxiliary Function was performed. In the example of staff duress, this would be the time the user first hits the panic button to call for help.

OUTtask0..1Task

The task indicates to recipients that an action should be taken. In the context of staff duress, the responder group who receives a staff duress notification should physically respond to the situation.

OUToutcome0..1OperationOutcome

Represents the outcome if there were any non-fatal warnings associated with the execution of the Auxiliary Function Notification operation.