FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/rtlsAuxiliaryFunction

Packagehl7.fhir.uv.rtls
Resource TypeOperationDefinition
IdrtlsAuxiliaryFunction
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/rtls/https://build.fhir.org/ig/HL7/rtls-ig/OperationDefinition-rtlsAuxiliaryFunction.html
URLhttp://hl7.org/fhir/uv/rtls/OperationDefinition/rtlsAuxiliaryFunction
Version1.0.0-ballot2
Statusdraft
Date2025-08-07T17:04:10+00:00
NameRTLSAuxiliaryFunction
TitleRTLS Auxiliary Function Operation
Realmuv
Authorityhl7
DescriptionRTLS Auxiliary Function
PurposeThis operation provides parameters for RTLS messaging functions.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition rtlsAuxiliaryFunction

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.


Source

{
  "resourceType": "OperationDefinition",
  "id": "rtlsAuxiliaryFunction",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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"
    }
  ]
}