Real Time Location Services Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/rtls-ig/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: RTLS Auxiliary Function Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "rtlsAuxiliaryFunction",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition rtlsAuxiliaryFunction</b></p><a name=\"rtlsAuxiliaryFunction\"> </a><a name=\"hcrtlsAuxiliaryFunction\"> </a><p>URL: [base]/$$auxiliary-function</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>event</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>IN</td><td>location</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/location.html\">Location</a></td><td/><td><div><p>The location represents a physical location in which the Auxiliary Function is going to be referencing.</p>\n</div></td></tr><tr><td>IN</td><td>device</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></td><td/><td><div><p>The device represents a physical device which will create the Auxiliary Function through some physical action.</p>\n</div></td></tr><tr><td>IN</td><td>timestamp</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>task</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/task.html\">Task</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Represents the outcome if there were any non-fatal warnings associated with the execution of the Auxiliary Function Notification operation.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pa"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "informative",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/rtls/ImplementationGuide/hl7.fhir.uv.rtls"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/rtls/OperationDefinition/rtlsAuxiliaryFunction",
  "version" : "1.0.0-ballot2",
  "name" : "RTLSAuxiliaryFunction",
  "title" : "RTLS Auxiliary Function Operation",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : true,
  "date" : "2025-08-07T17:04:10+00:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pafm"
        }
      ]
    }
  ],
  "description" : "RTLS Auxiliary Function",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "purpose" : "This operation provides parameters for RTLS messaging functions.",
  "code" : "auxiliary-function",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "event",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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.",
      "type" : "Coding"
    },
    {
      "name" : "location",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The location represents a physical location in which the Auxiliary Function is going to be referencing.",
      "type" : "Location"
    },
    {
      "name" : "device",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The device represents a physical device which will create the Auxiliary Function through some physical action.",
      "type" : "Device"
    },
    {
      "name" : "timestamp",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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.",
      "type" : "instant"
    },
    {
      "name" : "task",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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.",
      "type" : "Task"
    },
    {
      "name" : "outcome",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Represents the outcome if there were any non-fatal warnings associated with the execution of the Auxiliary Function Notification operation.",
      "type" : "OperationOutcome"
    }
  ]
}