Create a medical encounter
Módulo Safety
POST/medical-encountersmedicalEncounters.create
A medical encounter. Notes are Restricted, encrypted and never sent to a model. Creates a medical encounter. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requiere la capacidad safety.incident.write.
- Alcances de OAuth: safety.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Cuerpo de la solicitud: MedicalEncounterCreate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| incident_id | string (uuid) | Sí | Identifier of the incident. |
| patient_description | string | Sí | Who was treated, without identifying medical detail.Restricciones: length 1 to 300 |
| treatment_notes | string | null | No | Treatment given. Restricted.Restricciones: length 1 to 20000 |
| disposition | string | null | No | Outcome, such as released or transported.Restricciones: length 1 to 300 |
{
"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"patient_description": "Guest, adult",
"treatment_notes": "Abrasion to the left knee, cleaned and dressed.",
"disposition": "Released"
}Respuesta 201: MedicalEncounter
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the medical encounter. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| incident_id | string (uuid) | Sí | Identifier of the incident. |
| patient_description | string | Sí | Who was treated, without identifying medical detail.Restricciones: length 1 to 300 |
| treatment_notes | string | null | Sí | Treatment given. Restricted.Restricciones: length 1 to 20000 |
| disposition | string | null | Sí | Outcome, such as released or transported.Restricciones: length 1 to 300 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"patient_description": "Guest, adult",
"treatment_notes": "Abrasion to the left knee, cleaned and dressed.",
"disposition": "Released"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/medical-encounters" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"incident_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","patient_description":"Guest, adult","treatment_notes":"Abrasion to the left knee, cleaned and dressed.","disposition":"Released"}'const { data } = await xos.medicalEncounters.create({
"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"patient_description": "Guest, adult",
"treatment_notes": "Abrasion to the left knee, cleaned and dressed.",
"disposition": "Released"
});response = xos.medical_encounters.create({"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "patient_description": "Guest, adult", "treatment_notes": "Abrasion to the left knee, cleaned and dressed.", "disposition": "Released"})xos medical-encounters create --data '{"incident_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","patient_description":"Guest, adult","treatment_notes":"Abrasion to the left knee, cleaned and dressed.","disposition":"Released"}'