Saltar al contenido

Update a medical encounter

Módulo Safety

PATCH/medical-encounters/{id}medicalEncounters.update

A medical encounter. Notes are Restricted, encrypted and never sent to a model. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad safety.incident.write.
  • Alcances de OAuth: safety.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

medicalEncounters.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the medical encounter.

Cuerpo de la solicitud: MedicalEncounterUpdate

medicalEncounters.update: MedicalEncounterUpdate
CampoTipoObligatorioDescripción
patient_descriptionstringNoWho was treated, without identifying medical detail.Restricciones: length 1 to 300
treatment_notesstring | nullNoTreatment given. Restricted.Restricciones: length 1 to 20000
dispositionstring | nullNoOutcome, such as released or transported.Restricciones: length 1 to 300
{
  "patient_description": "Guest, adult",
  "treatment_notes": "Abrasion to the left knee, cleaned and dressed.",
  "disposition": "Released"
}

Respuesta 200: MedicalEncounter

medicalEncounters.update: MedicalEncounter
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the medical encounter.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
incident_idstring (uuid)SíIdentifier of the incident.
patient_descriptionstringSíWho was treated, without identifying medical detail.Restricciones: length 1 to 300
treatment_notesstring | nullSíTreatment given. Restricted.Restricciones: length 1 to 20000
dispositionstring | nullSí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 PATCH "$XOS_BASE_URL/medical-encounters/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"patient_description":"Guest, adult","treatment_notes":"Abrasion to the left knee, cleaned and dressed.","disposition":"Released"}'
const { data, etag } = await xos.medicalEncounters.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "patient_description": "Guest, adult",
    "treatment_notes": "Abrasion to the left knee, cleaned and dressed.",
    "disposition": "Released"
  }, { ifMatch: etag });
response = xos.medical_encounters.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"patient_description": "Guest, adult", "treatment_notes": "Abrasion to the left knee, cleaned and dressed.", "disposition": "Released"}, if_match=etag)
xos medical-encounters update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"patient_description":"Guest, adult","treatment_notes":"Abrasion to the left knee, cleaned and dressed.","disposition":"Released"}' --if-match auto