Skip to content

Commit 344f871

Browse files
docs(asyncapi): add documentation for medical technology usage event
1 parent 9fcca62 commit 344f871

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

docs/asyncapi/asyncapi.yml

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags:
66
- name: register
77
info:
88
title: Digital Twins Event Gateway
9-
version: 1.0.0
9+
version: 1.3.1
1010
description: |
1111
The Gateway between Azure Digital Twins and the application microservices.
1212
### Features:
@@ -32,6 +32,7 @@ channels:
3232
room-events:
3333
description: The topic on which room events are published and consumed.
3434
subscribe:
35+
operationId: getRoomEvent
3536
summary: |
3637
Send room informations such as temperature, luminosity, humidity, etc.
3738
message:
@@ -44,16 +45,20 @@ channels:
4445
process-events:
4546
description: The topic on which process events are published and consumed.
4647
subscribe:
48+
operationId: getProcessEvent
4749
summary: |
4850
Send all process events.
4951
message:
5052
oneOf:
5153
- "$ref": '#/components/messages/medicalDeviceUsageEvent'
5254
- "$ref": "#/components/messages/processInfoEvent"
55+
- "$ref": '#/components/messages/medicalTechnologyUsageEvent'
56+
5357

5458
tracking-events:
5559
description: The topic on which health professionals tracking events are published and consumed.
5660
subscribe:
61+
operationId: getTrackingEvents
5762
summary: |
5863
Send the tracking event of a health professional within an operating block room.
5964
message:
@@ -104,6 +109,13 @@ components:
104109
contentType: application/json
105110
payload:
106111
$ref: "#/components/schemas/processInfoEventPayload"
112+
medicalTechnologyUsageEvent:
113+
name: medicalTechnologyUsageEvent
114+
title: The Medical Technology Usage Event
115+
summary: the event of usage of a medical technology in a process.
116+
contentType: application/json
117+
payload:
118+
$ref: "#/components/schemas/medicalTechnologyUsageEventPayload"
107119

108120
trackingEvent:
109121
name: trackingEvent
@@ -191,7 +203,18 @@ components:
191203
dateTime:
192204
type: string
193205
description: the timestamp of the event.
194-
206+
medicalTechnologyUsageEventPayload:
207+
type: object
208+
properties:
209+
key:
210+
type: string
211+
description: The key of the event.
212+
data:
213+
type: object
214+
$ref: "#/components/schemas/medicalTechnologyUsage"
215+
dateTime:
216+
type: string
217+
description: the timestamp of the event.
195218
processInfoEventPayload:
196219
type: object
197220
properties:
@@ -268,6 +291,16 @@ components:
268291
type: string
269292
description: The id of the process.
270293

294+
medicalTechnologyUsage:
295+
type: object
296+
properties:
297+
medicalTechnologyID:
298+
type: string
299+
description: The id of the medical technology.
300+
isInUse:
301+
type: boolean
302+
description: true if the technology is in use, false otherwise.
303+
271304
processInfo:
272305
type: object
273306
properties:

0 commit comments

Comments
 (0)