Automation Management Microservice 1.0.0 documentation

Automation Management Microservice 1.0.0

MIT
application/json
API Support
info@smartoperatingblock.com
ID: https://github.com/smartoperatingblock/automation-management-microserive

The Automation Management Microservice of the Smart Operating Block project.

Features:

Manage the automation scenarios within the Operating Block
Receive custom automation scenario requests

#automation scenarios
#medical technologies support
#environment monitoring and management

Servers

http://broker:29092kafkaproduction
The event broker

Security:
security.protocol:PLAINTEXT

Operations

SUB automation-proposal-events
The topic on which the automation scenario proposals are published.

Get automation scenario proposals in order to understand how it is possible to adapt the environment to the current state.
Operation IDgetAutomationScenarioProposals
Accepts the following message:
Medical Technology Automation Proposal eventmedicalTechnologyAutomationProposalEvent
The event with which the microservice proposes an automation scenario to support the usage of a Medical Technology.
application/json
Message IDmedicalTechnologyAutomationProposalEvent
object
uid: medicalTechnologyAutomationProposalEventSchema
key
string
The key of the event.

Const:"MEDICAL_TECHNOLOGY_AUTOMATION_PROPOSAL_EVENT"
object
roomId
string
The room id where the medical technology is being used.

medicalTechnologyType
string
The medical technology type currently in use.

Allowed values:
"endoscope"
"xray"
ambientLightLux
integer
The lux proposed to set in ambient lights.

surgicalLightLux
integer
The lux proposed to set in surgical lights.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
Examples
{ "key": "MEDICAL_TECHNOLOGY_AUTOMATION_PROPOSAL_EVENT", "data": { "roomId": "string", "medicalTechnologyType": "endoscope", "ambientLightLux": 0, "surgicalLightLux": 0 }, "dateTime": "string" }

This example has been generated automatically.
PUB automation-requests-events
The topic on which the microservice expects to find requests for automation scenarios already proposed or not.

Request an automation scenario to the microservice.
Operation IDrequestAutomationScenario
Accepts one of the following messages:
- #0Medical Technology Automation Request eventmedicalTechnologyAutomationRequestEvent
  The event needed to request an automation scenario to adapt the environment to a medical technology usage. It's not needed a beforehand proposal, but the medical technology must be in use.
  application/json
  Message IDmedicalTechnologyAutomationRequestEvent
  object
  uid: medicalTechnologyAutomationRequestEventSchema
  key
  string
  The key of the event.
  
  Const:"MEDICAL_TECHNOLOGY_AUTOMATION_REQUEST_EVENT"
  object
  roomId
  string
  The room id where request the automation scenario.
  
  medicalTechnologyType
  string
  The medical technology type for which request the automation scenario.
  
  Allowed values:
  "endoscope"
  "xray"
  Additional properties are allowed.
  dateTime
  string
  The timestamp of the event. It must comply with the ISO 8601 standard.
  
  Additional properties are allowed.
  Examples
  { "key": "MEDICAL_TECHNOLOGY_AUTOMATION_REQUEST_EVENT", "data": { "roomId": "string", "medicalTechnologyType": "endoscope" }, "dateTime": "string" }
  
  This example has been generated automatically.
- #1Custom Light Request eventcustomLightRequest
  The event needed to request a custom setup for the lights inside an operating room.
  application/json
  Message IDcustomLightRequest
  object
  uid: customLightRequestEventSchema
  key
  string
  The key of the event.
  
  Const:"CUSTOM_LIGHT_SETUP_REQUEST_EVENT"
  object
  roomId
  string
  The ID of the room in which to apply the custom light setting.
  
  ambientLightLux
  integer
  The lux to set in ambient lights.
  
  surgicalLightLux
  integer
  The lux to set in surgical lights.
  
  Additional properties are allowed.
  dateTime
  string
  The timestamp of the event. It must comply with the ISO 8601 standard.
  
  Additional properties are allowed.
  Examples
  { "key": "CUSTOM_LIGHT_SETUP_REQUEST_EVENT", "data": { "roomId": "string", "ambientLightLux": 0, "surgicalLightLux": 0 }, "dateTime": "string" }
  
  This example has been generated automatically.
- #2Custom Light Stop eventcustomLightStop
  The event needed to stop the usage of the custom setup for the lights inside an operating room.
  application/json
  Message IDcustomLightStop
  object
  uid: customLightStopEventSchema
  key
  string
  The key of the event.
  
  Const:"CUSTOM_LIGHT_STOP_REQUEST_EVENT"
  object
  roomId
  string
  The ID of the room in which to stop the custom light setting.
  
  Additional properties are allowed.
  dateTime
  string
  The timestamp of the event. It must comply with the ISO 8601 standard.
  
  Additional properties are allowed.
  Examples
  { "key": "CUSTOM_LIGHT_STOP_REQUEST_EVENT", "data": { "roomId": "string" }, "dateTime": "string" }
  
  This example has been generated automatically.

Messages

#1Medical Technology Automation Proposal eventmedicalTechnologyAutomationProposalEvent
The event with which the microservice proposes an automation scenario to support the usage of a Medical Technology.
- application/json
Message IDmedicalTechnologyAutomationProposalEvent
object
uid: medicalTechnologyAutomationProposalEventSchema
key
string
The key of the event.

Const:"MEDICAL_TECHNOLOGY_AUTOMATION_PROPOSAL_EVENT"
object
roomId
string
The room id where the medical technology is being used.

medicalTechnologyType
string
The medical technology type currently in use.

Allowed values:
"endoscope"
"xray"
ambientLightLux
integer
The lux proposed to set in ambient lights.

surgicalLightLux
integer
The lux proposed to set in surgical lights.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
#2Medical Technology Automation Request eventmedicalTechnologyAutomationRequestEvent
The event needed to request an automation scenario to adapt the environment to a medical technology usage. It's not needed a beforehand proposal, but the medical technology must be in use.
- application/json
Message IDmedicalTechnologyAutomationRequestEvent
object
uid: medicalTechnologyAutomationRequestEventSchema
key
string
The key of the event.

Const:"MEDICAL_TECHNOLOGY_AUTOMATION_REQUEST_EVENT"
object
roomId
string
The room id where request the automation scenario.

medicalTechnologyType
string
The medical technology type for which request the automation scenario.

Allowed values:
"endoscope"
"xray"
Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
#3Custom Light Request eventcustomLightRequest
The event needed to request a custom setup for the lights inside an operating room.
- application/json
Message IDcustomLightRequest
object
uid: customLightRequestEventSchema
key
string
The key of the event.

Const:"CUSTOM_LIGHT_SETUP_REQUEST_EVENT"
object
roomId
string
The ID of the room in which to apply the custom light setting.

ambientLightLux
integer
The lux to set in ambient lights.

surgicalLightLux
integer
The lux to set in surgical lights.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
#4Custom Light Stop eventcustomLightStop
The event needed to stop the usage of the custom setup for the lights inside an operating room.
- application/json
Message IDcustomLightStop
object
uid: customLightStopEventSchema
key
string
The key of the event.

Const:"CUSTOM_LIGHT_STOP_REQUEST_EVENT"
object
roomId
string
The ID of the room in which to stop the custom light setting.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.

Schemas

object
uid: medicalTechnologyAutomationProposalEventSchema
key
string
The key of the event.

Const:"MEDICAL_TECHNOLOGY_AUTOMATION_PROPOSAL_EVENT"
object
roomId
string
The room id where the medical technology is being used.

medicalTechnologyType
string
The medical technology type currently in use.

Allowed values:
"endoscope"
"xray"
ambientLightLux
integer
The lux proposed to set in ambient lights.

surgicalLightLux
integer
The lux proposed to set in surgical lights.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
object
uid: medicalTechnologyAutomationProposalPayload
roomId
string
The room id where the medical technology is being used.

medicalTechnologyType
string
The medical technology type currently in use.

Allowed values:
"endoscope"
"xray"
ambientLightLux
integer
The lux proposed to set in ambient lights.

surgicalLightLux
integer
The lux proposed to set in surgical lights.

Additional properties are allowed.
object
uid: medicalTechnologyAutomationRequestEventSchema
key
string
The key of the event.

Const:"MEDICAL_TECHNOLOGY_AUTOMATION_REQUEST_EVENT"
object
roomId
string
The room id where request the automation scenario.

medicalTechnologyType
string
The medical technology type for which request the automation scenario.

Allowed values:
"endoscope"
"xray"
Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
object
uid: medicalTechnologyAutomationRequestPayload
roomId
string
The room id where request the automation scenario.

medicalTechnologyType
string
The medical technology type for which request the automation scenario.

Allowed values:
"endoscope"
"xray"
Additional properties are allowed.
object
uid: customLightRequestEventSchema
key
string
The key of the event.

Const:"CUSTOM_LIGHT_SETUP_REQUEST_EVENT"
object
roomId
string
The ID of the room in which to apply the custom light setting.

ambientLightLux
integer
The lux to set in ambient lights.

surgicalLightLux
integer
The lux to set in surgical lights.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
object
uid: customLightRequestPayload
roomId
string
The ID of the room in which to apply the custom light setting.

ambientLightLux
integer
The lux to set in ambient lights.

surgicalLightLux
integer
The lux to set in surgical lights.

Additional properties are allowed.
object
uid: customLightStopEventSchema
key
string
The key of the event.

Const:"CUSTOM_LIGHT_STOP_REQUEST_EVENT"
object
roomId
string
The ID of the room in which to stop the custom light setting.

Additional properties are allowed.
dateTime
string
The timestamp of the event. It must comply with the ISO 8601 standard.

Additional properties are allowed.
object
uid: customLightStopPayload
roomId
string
The ID of the room in which to stop the custom light setting.

Additional properties are allowed.

Automation Management Microservice 1.0.0

Features:

Servers

Security:

Operations

SUB automation-proposal-events

Examples

This example has been generated automatically.

PUB automation-requests-events

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Messages

Schemas