jpsoron commited on
Commit
88d524e
Β·
unverified Β·
2 Parent(s): 9e1a4283ac37aa

Merge pull request #7 from MateFerreyra/jps/docs-restructure

Browse files
documentation/M6_demo_payloads.md DELETED
@@ -1,291 +0,0 @@
1
- # M6 β€” Payloads de demo (webhooks entrantes)
2
-
3
- Ejemplos listos para copiar y pegar de los webhooks que **otros mΓ³dulos llaman sobre M6**.
4
- Backend real (desplegado): `https://modulo-6-api.hf.space/api/v1`.
5
- Docs interactivas: `https://modulo-6-api.hf.space/api/v1/docs`.
6
-
7
- > Todos estos endpoints requieren **autenticaciΓ³n JWT** (`Authorization: Bearer <token>`).
8
- > Si el backend tiene habilitado el endpoint de token de desarrollo (`ENVIRONMENT=development`),
9
- > obtenΓ© uno asΓ­:
10
- >
11
- > ```bash
12
- > curl "https://modulo-6-api.hf.space/api/v1/auth/token?usuario=ADMINISTRATIVO&password=x"
13
- > ```
14
- >
15
- > Respuesta: `{ "access_token": "eyJ...", "token_type": "bearer", "rol": "ADMINISTRATIVO" }`.
16
- > Si estΓ‘ en modo producciΓ³n, ese endpoint devuelve `404` y el token lo tenΓ©s que emitir
17
- > desde Core (M10). En cualquier caso, exportalo para reutilizarlo en los `curl` de abajo:
18
- >
19
- > ```bash
20
- > export TOKEN="eyJ..."
21
- > ```
22
-
23
- Convenciones: timestamps en **ISO 8601 UTC con sufijo `Z`**. IDs de cama/paciente son `integer`;
24
- los IDs de origen externos (`solicitud_hce_id`, etc.) son `string` con prefijo.
25
-
26
- ---
27
-
28
- ## 1. [M1] Recibir solicitud β€” internaciΓ³n o traslado
29
-
30
- `POST /webhooks/hce/solicitud` Β· emisor: **M1 HCE** Β· crea la solicitud en estado `PENDIENTE`.
31
- El mismo endpoint cubre los dos casos segΓΊn `tipo`.
32
-
33
- ### 1.a β€” InternaciΓ³n (desde guardia)
34
-
35
- ```bash
36
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/hce/solicitud" \
37
- -H "Authorization: Bearer $TOKEN" \
38
- -H "Content-Type: application/json" \
39
- -d '{
40
- "tipo": "INTERNACION",
41
- "solicitud_hce_id": "HCE-SOL-001",
42
- "paciente_id": 7,
43
- "medico_solicitante_id": 10,
44
- "cama_solicitada_id": 101,
45
- "origen": "GUARDIA",
46
- "diagnostico_ingreso": "NeumonΓ­a adquirida en la comunidad",
47
- "obra_social_id": "OSDE-210",
48
- "numero_afiliado": "A-99887766",
49
- "prioridad": "ALTA",
50
- "hospital_id": "HOSP-001",
51
- "observaciones": "Paciente requiere oxΓ­geno suplementario",
52
- "timestamp": "2025-01-18T10:30:00Z"
53
- }'
54
- ```
55
-
56
- ### 1.b β€” InternaciΓ³n por cirugΓ­a programada
57
-
58
- Igual que 1.a pero con `origen: "CIRUGIA_PROGRAMADA"` y `turno_id` del turno quirΓΊrgico
59
- (M6 lo valida contra M2 antes de aprobar).
60
-
61
- ```bash
62
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/hce/solicitud" \
63
- -H "Authorization: Bearer $TOKEN" \
64
- -H "Content-Type: application/json" \
65
- -d '{
66
- "tipo": "INTERNACION",
67
- "solicitud_hce_id": "HCE-SOL-002",
68
- "paciente_id": 12,
69
- "medico_solicitante_id": 10,
70
- "cama_solicitada_id": 205,
71
- "origen": "CIRUGIA_PROGRAMADA",
72
- "turno_id": 5501,
73
- "diagnostico_ingreso": "Postoperatorio colecistectomΓ­a",
74
- "prioridad": "MEDIA",
75
- "hospital_id": "HOSP-001",
76
- "timestamp": "2025-01-18T11:00:00Z"
77
- }'
78
- ```
79
-
80
- ### 1.c β€” Traslado / pase de piso
81
-
82
- ```bash
83
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/hce/solicitud" \
84
- -H "Authorization: Bearer $TOKEN" \
85
- -H "Content-Type: application/json" \
86
- -d '{
87
- "tipo": "TRASLADO",
88
- "solicitud_hce_id": "HCE-SOL-003",
89
- "paciente_id": 7,
90
- "medico_solicitante_id": 10,
91
- "cama_origen_id": 101,
92
- "cama_destino_solicitada_id": 310,
93
- "motivo_traslado": "Mejora clΓ­nica, pasa de UTI a sala comΓΊn",
94
- "prioridad": "BAJA",
95
- "hospital_id": "HOSP-001",
96
- "timestamp": "2025-01-18T14:20:00Z"
97
- }'
98
- ```
99
-
100
- **Campos.** Requeridos siempre: `tipo`, `solicitud_hce_id`, `paciente_id`, `medico_solicitante_id`, `timestamp`.
101
- `tipo`: `INTERNACION` | `TRASLADO`. `origen`: `GUARDIA` | `CIRUGIA_PROGRAMADA`.
102
- `prioridad`: `MUY_BAJA` | `BAJA` | `MEDIA` | `ALTA` | `MUY_ALTA` | `URGENTE`.
103
- Para `TRASLADO` se usan `cama_origen_id` y `cama_destino_solicitada_id`; el resto es opcional.
104
-
105
- **Respuesta 200:**
106
-
107
- ```json
108
- {
109
- "mensaje": "Solicitud recibida y pendiente de aprobaciΓ³n",
110
- "solicitud_id": "SOL-00001",
111
- "estado": "PENDIENTE"
112
- }
113
- ```
114
-
115
- ---
116
-
117
- ## 2. [M1] Recibir solicitud de cirugΓ­a urgente
118
-
119
- `POST /webhooks/hce/cirugia-urgente` Β· emisor: **M1 HCE**.
120
- Algoritmo **ASAP**: `fecha_hora_inicio` se interpreta como "no antes de" y la resta con
121
- `fecha_hora_fin_estimada` como la duraciΓ³n de la cirugΓ­a. M6 calcula, entre los quirΓ³fanos
122
- compatibles (mismo hospital, operables), el inicio mΓ‘s temprano posible y asigna ahΓ­ β€”
123
- el horario final puede no coincidir con el pedido. Si para lograrlo hay que correr alguna
124
- reserva programada, esa reserva **no se cancela**: se **reprograma** en M2 (algoritmo
125
- `reprogramar()`) preservando su duraciΓ³n. Reservas `EN_CURSO` o ya `URGENTE` nunca se
126
- desplazan; pueden ser varias las reservas desplazadas dentro de la ventana elegida.
127
-
128
- ```bash
129
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/hce/cirugia-urgente" \
130
- -H "Authorization: Bearer $TOKEN" \
131
- -H "Content-Type: application/json" \
132
- -d '{
133
- "solicitud_urgencia_hce_id": "HCE-URG-001",
134
- "paciente_id": 33,
135
- "medico_cirujano_id": 22,
136
- "medico_solicitante_id": 10,
137
- "fecha_hora_inicio": "2025-01-18T16:00:00Z",
138
- "fecha_hora_fin_estimada": "2025-01-18T18:00:00Z",
139
- "diagnostico": "Apendicitis aguda perforada",
140
- "hospital_id": "HOSP-001",
141
- "timestamp": "2025-01-18T15:45:00Z"
142
- }'
143
- ```
144
-
145
- **Campos.** Requeridos: `solicitud_urgencia_hce_id`, `paciente_id`, `medico_cirujano_id`,
146
- `medico_solicitante_id`, `fecha_hora_inicio`, `fecha_hora_fin_estimada`, `timestamp`.
147
- `fecha_hora_inicio` debe ser anterior a `fecha_hora_fin_estimada` (si no β†’ `422`).
148
- Opcionales: `diagnostico`, `hospital_id`, `specialty_id` (preferencia de especialidad del
149
- quirΓ³fano; si no hay quirΓ³fano libre de esa especialidad se usa cualquier otro compatible
150
- del hospital, no se deja al paciente sin asignar).
151
-
152
- **Respuesta 201 (sin desplazamiento):**
153
-
154
- ```json
155
- {
156
- "mensaje": "Reserva urgente creada exitosamente",
157
- "reserva": {
158
- "id": 9,
159
- "cama_id": 501,
160
- "origen": "EMERGENCIA",
161
- "estado": "RESERVADA",
162
- "prioridad": "URGENTE",
163
- "paciente_id": 33
164
- },
165
- "reservas_desplazadas": []
166
- }
167
- ```
168
-
169
- **Respuesta 201 (con desplazamiento):** `reservas_desplazadas` trae la(s) reserva(s)
170
- programada(s) que fueron reprogramadas (siguen `RESERVADA`, con nuevo horario; `turno_id`
171
- reprogramado en M2 si correspondΓ­a). Puede haber mΓ‘s de una si varias caΓ­an dentro de la
172
- ventana elegida.
173
-
174
- **Respuesta 200:** si `solicitud_urgencia_hce_id` ya se habΓ­a procesado (idempotencia),
175
- se devuelve la reserva existente sin crear nada nuevo, con `200` en vez de `201`.
176
-
177
- **Respuesta 409** `SIN_QUIROFANO_COMPATIBLE`: no hay ningΓΊn quirΓ³fano operable
178
- (`FUERA_DE_SERVICIO`/`BAJA_PERMANENTE`/`EN_LIMPIEZA` excluidos) para el `hospital_id`
179
- indicado.
180
-
181
- ---
182
-
183
- ## 3. [M9] Recibir alerta de emergencia (cΓ³digo rojo)
184
-
185
- `POST /webhooks/monitoreo/alerta-emergencia` Β· emisor: **M9 Monitoreo**.
186
- M6 localiza la cama `OCUPADA` del paciente y la pone en `CODIGO_ROJO`.
187
-
188
- ```bash
189
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/monitoreo/alerta-emergencia" \
190
- -H "Authorization: Bearer $TOKEN" \
191
- -H "Content-Type: application/json" \
192
- -d '{
193
- "paciente_id": 7,
194
- "observaciones": "HR > 140 sostenida por 3 min, SpO2 88%",
195
- "timestamp": "2025-01-18T19:05:00Z"
196
- }'
197
- ```
198
-
199
- **Campos.** Requeridos: `paciente_id`, `timestamp`. Opcional: `observaciones`.
200
-
201
- **Respuesta 200:**
202
-
203
- ```json
204
- {
205
- "mensaje": "Alerta registrada. Cama 101 en CODIGO_ROJO.",
206
- "cama_id": 101,
207
- "sector": "UTI"
208
- }
209
- ```
210
-
211
- > Si el paciente no tiene cama asignada β†’ `404`.
212
-
213
- ---
214
-
215
- ## 4. [M9] Recibir alerta resuelta
216
-
217
- `POST /webhooks/monitoreo/alerta-resuelta` Β· emisor: **M9 Monitoreo**.
218
- La cama vuelve de `CODIGO_ROJO` a `OCUPADA` (no a `DISPONIBLE`).
219
-
220
- ```bash
221
- curl -X POST "https://modulo-6-api.hf.space/api/v1/webhooks/monitoreo/alerta-resuelta" \
222
- -H "Authorization: Bearer $TOKEN" \
223
- -H "Content-Type: application/json" \
224
- -d '{
225
- "paciente_id": 7,
226
- "motivo_resolucion": "Paciente estabilizado tras intervenciΓ³n de enfermerΓ­a",
227
- "timestamp": "2025-01-18T19:20:00Z"
228
- }'
229
- ```
230
-
231
- **Campos.** Requeridos: `paciente_id`, `timestamp`. Opcional: `motivo_resolucion`.
232
-
233
- **Respuesta 200:**
234
-
235
- ```json
236
- {
237
- "mensaje": "Alerta resuelta. Cama 101 volviΓ³ a estado OCUPADA.",
238
- "cama_id": 101,
239
- "estado_anterior": "CODIGO_ROJO",
240
- "estado_actual": "OCUPADA"
241
- }
242
- ```
243
-
244
- > Si no hay cama en `CODIGO_ROJO` para ese paciente β†’ `404`.
245
-
246
- ---
247
-
248
- ## 5. [M2] Cancelar reserva de quirΓ³fano por turno
249
-
250
- `POST /turnos/{turnoId}/cancelacion` Β· emisor: **M2 Turnos**.
251
- `turnoId` (entero, el id del turno en M2) va en la URL. M6 busca la reserva asociada al
252
- turno y la pasa a `CANCELADA`, liberando el quirΓ³fano.
253
-
254
- ```bash
255
- curl -X POST "https://modulo-6-api.hf.space/api/v1/turnos/5501/cancelacion" \
256
- -H "Authorization: Bearer $TOKEN" \
257
- -H "Content-Type: application/json" \
258
- -d '{
259
- "motivo": "El paciente reprogramΓ³ la cirugΓ­a",
260
- "tipo_cancelacion": "REPROGRAMACION",
261
- "timestamp": "2025-01-18T09:10:00Z"
262
- }'
263
- ```
264
-
265
- **Campos.** Requeridos: `motivo`, `timestamp`. Opcional: `tipo_cancelacion`.
266
-
267
- **Respuesta 200:**
268
-
269
- ```json
270
- {
271
- "mensaje": "Reserva de quirΓ³fano cancelada correctamente",
272
- "reserva_id": 9,
273
- "turno_id": 5501,
274
- "cama_id": 501,
275
- "estado": "CANCELADA"
276
- }
277
- ```
278
-
279
- > Estados de la respuesta: si la reserva ya estaba `CANCELADA`, responde igual (idempotente).
280
- > Si estΓ‘ `EN_CURSO` o `COMPLETADA` β†’ `409` (no cancelable). Si no existe reserva para el turno β†’ `404`.
281
-
282
- ---
283
-
284
- ## Orden sugerido para la demo
285
-
286
- 1. Crear una cama y un quirΓ³fano (`POST /camas`, `POST /quirofanos`).
287
- 2. **(1.a)** Internar un paciente: webhook de solicitud β†’ `PATCH /solicitudes/{id}` para aprobar.
288
- 3. **(3)** Disparar alerta de emergencia sobre ese paciente β†’ ver cama en `CODIGO_ROJO`.
289
- 4. **(4)** Resolver la alerta β†’ cama vuelve a `OCUPADA`.
290
- 5. **(5)** Crear una reserva programada (`POST /quirofanos/{id}/reservas`) y cancelarla por turno.
291
- 6. **(2)** Disparar una cirugΓ­a urgente que desplace a una programada existente.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
documentation/{M10_SSO_INTEGRATION_GUIDE.md β†’ integrations/M10_SSO_INTEGRATION_GUIDE.md} RENAMED
File without changes
documentation/{M10_integration.md β†’ integrations/M10_integration.md} RENAMED
File without changes
documentation/{M10_openapi.yaml β†’ integrations/openapi_docs/M10_openapi.yaml} RENAMED
File without changes
documentation/{M1_docs.html β†’ integrations/openapi_docs/M1_docs.html} RENAMED
File without changes
documentation/{M2_openapi.json β†’ integrations/openapi_docs/M2_openapi.json} RENAMED
File without changes